-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from nicolasaunai/readme
update package name
- Loading branch information
Showing
23 changed files
with
92 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,7 @@ Types of Contributions | |
Report Bugs | ||
~~~~~~~~~~~ | ||
|
||
Report bugs at https://github.com/nicolasaunai/space/issues. | ||
Report bugs at https://github.com/LaboratoryOfPlasmaPhysics/spok. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
|
@@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it. | |
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
space could always use more documentation, whether as part of the | ||
official space docs, in docstrings, or even on the web in blog posts, | ||
`spok` could always use more documentation, whether as part of the | ||
official `spok` docs, in docstrings, or even on the web in blog posts, | ||
articles, and such. | ||
|
||
Submit Feedback | ||
~~~~~~~~~~~~~~~ | ||
|
||
The best way to send feedback is to file an issue at https://github.com/nicolasaunai/space/issues. | ||
The best way to send feedback is to file an issue at https://github.com/LaboratoryOfPlasmaPhysics/spok | ||
|
||
If you are proposing a feature: | ||
|
||
|
@@ -59,15 +59,15 @@ Get Started! | |
|
||
Ready to contribute? Here's how to set up `space` for local development. | ||
|
||
1. Fork the `space` repo on GitHub. | ||
1. Fork the `spok` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/space.git | ||
$ git clone [email protected]:your_name_here/spok.git | ||
|
||
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: | ||
|
||
$ mkvirtualenv space | ||
$ cd space/ | ||
$ mkvirtualenv spok | ||
$ cd spok/ | ||
$ python setup.py develop | ||
|
||
4. Create a branch for local development:: | ||
|
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `space` for local development. | |
5. When you're done making changes, check that your changes pass flake8 and the | ||
tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 space tests | ||
$ flake8 spok tests | ||
$ python setup.py test or pytest | ||
$ tox | ||
|
||
|
@@ -103,7 +103,7 @@ Before you submit a pull request, check that it meets these guidelines: | |
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check | ||
https://travis-ci.com/nicolasaunai/space/pull_requests | ||
https://github.com/LaboratoryOfPlasmaPhysics/spok/pulls | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
|
@@ -112,7 +112,7 @@ Tips | |
To run a subset of tests:: | ||
|
||
|
||
$ python -m unittest tests.test_space | ||
$ python -m unittest tests.test_spok | ||
|
||
Deploying | ||
--------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,21 @@ | ||
# space | ||
# SPOK | ||
|
||
[![PyPI](https://img.shields.io/pypi/v/space)](https://pypi.python.org/pypi/space) | ||
[![Tests](https://github.com/LaboratoryOfPlasmaPhysics/space/actions/workflows/test_main.yml/badge.svg)](https://github.com/LaboratoryOfPlasmaPhysics/space/actions/workflows/test_main.yml) | ||
[![Documentation Status](https://readthedocs.org/projects/space/badge/?version=latest)](https://space.readthedocs.io/en/latest/?badge=latest) | ||
[![Coverage Status](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/space/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/space/branch/main) | ||
[![PyPI](https://img.shields.io/pypi/v/spok)](https://pypi.python.org/pypi/spok) | ||
[![Tests](https://github.com/LaboratoryOfPlasmaPhysics/spok/actions/workflows/test_main.yml/badge.svg)](https://github.com/LaboratoryOfPlasmaPhysics/spok/actions/workflows/test_main.yml) | ||
[![Documentation Status](https://readthedocs.org/projects/spok/badge/?version=latest)](https://spok.readthedocs.io/en/latest/?badge=latest) | ||
[![Coverage Status](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/spok/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/spok/branch/main) | ||
|
||
Space Plasma Analysis CodE | ||
spok Plasma Observations Kit | ||
|
||
![space](https://user-images.githubusercontent.com/3200931/98716891-978e2180-238c-11eb-9487-07c66221e5bb.png) | ||
![spok](https://user-images.githubusercontent.com/3200931/98716891-978e2180-238c-11eb-9487-07c66221e5bb.png) | ||
|
||
|
||
* Free software: GNU General Public License v3 | ||
* Documentation: https://space.readthedocs.io. | ||
* Documentation: https://spok.readthedocs.io. | ||
|
||
|
||
## Features | ||
|
||
|
||
## TODO | ||
|
||
## Credits | ||
|
||
|
||
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,10 +3,10 @@ build-backend = "flit_core.buildapi" | |
requires = ["flit_core"] | ||
|
||
[project] | ||
name = "space" | ||
name = "spok" | ||
version = "0.1.0" | ||
description = "Space Plasma Analysis CodE" | ||
keywords = ["space", "plasma-physics"] | ||
description = "Space Plasmas Observations Kit" | ||
keywords = ["spok", "plasma-physics"] | ||
authors = [ | ||
{ name = "Nicolas Aunai", email = "[email protected]" } | ||
] | ||
|
@@ -33,6 +33,6 @@ classifiers = [ | |
] | ||
dependencies = ["pandas", "numpy", "matplotlib", "scipy"] | ||
[project.urls] | ||
homepage = "https://github.com/LaboratoryOfPlasmaPhysics/space" | ||
homepage = "https://github.com/LaboratoryOfPlasmaPhysics/spok" | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
"""Top-level package for spok.""" | ||
|
||
__author__ = """Nicolas Aunai""" | ||
__email__ = "[email protected]" | ||
__version__ = "0.1.0" |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
"""Unit test package for space.""" | ||
"""Unit test package for spok.""" |
Oops, something went wrong.