Skip to content

Commit f20c935

Browse files
michaelayemichaelaye
committed
first commit
0 parents  commit f20c935

34 files changed

+1652
-0
lines changed

‎.circleci/config.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
version: 2
2+
jobs:
3+
build:
4+
docker:
5+
- image: continuumio/miniconda3
6+
7+
working_directory: ~/repo
8+
9+
steps:
10+
- checkout
11+
12+
13+
# - restore_cache:
14+
# keys:
15+
# - v1-dependencies-{{ checksum "environment.yml" }}
16+
# - v1-dependencies-
17+
18+
19+
- run:
20+
name: install dependencies
21+
command: |
22+
# conda env create -q || conda env update -q
23+
# source activate adj
24+
conda install -qy conda-build anaconda-client pytest pytest-cov
25+
conda config --set auto_update_conda no
26+
conda info -a
27+
conda build conda.recipe --no-test
28+
conda install --use-local planets
29+
30+
# - save_cache:
31+
# paths:
32+
# - /opt/conda
33+
# key: v1-dependencies-{{ checksum "environment.yml" }}
34+
35+
36+
- run:
37+
name: run tests
38+
command: |
39+
# source activate adj
40+
pytest --color=yes -v --cov=planets tests
41+
conda install -c conda-forge codecov
42+
codecov
43+
- store_artifacts:
44+
path: test-reports
45+
destination: test-reports

‎.codacy.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
exclude_paths:
3+
- 'tests/**/*'
4+
- 'tests/*'
5+
- 'benchmarks/**/*'
6+
- 'setup.py'

‎.coveragerc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[report]
2+
omit =
3+
setup.py
4+
planets/__main__.py
5+
tests/*

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

‎.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* planets version:
2+
* Python version:
3+
* Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.gitignore

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
*.egg-info/
24+
.installed.cfg
25+
*.egg
26+
27+
# PyInstaller
28+
# Usually these files are written by a python script from a template
29+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
30+
*.manifest
31+
*.spec
32+
33+
# Installer logs
34+
pip-log.txt
35+
pip-delete-this-directory.txt
36+
37+
# Unit test / coverage reports
38+
htmlcov/
39+
.tox/
40+
.coverage
41+
.coverage.*
42+
.cache
43+
nosetests.xml
44+
coverage.xml
45+
*,cover
46+
.hypothesis/
47+
48+
# Translations
49+
*.mo
50+
*.pot
51+
52+
# Django stuff:
53+
*.log
54+
55+
# Sphinx documentation
56+
docs/_build/
57+
58+
# PyBuilder
59+
target/
60+
61+
# pyenv python configuration file
62+
.python-version
63+
64+
# VSCode editor settings
65+
.vscode
66+
67+
# New Pytest report
68+
junit.xml

‎.travis.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Config file for automatic testing at travis-ci.org
2+
# This file will be regenerated if you run travis_pypi_setup.py
3+
4+
language: python
5+
python:
6+
- 3.7
7+
8+
9+
install:
10+
- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
11+
- bash miniconda.sh -b -p $HOME/miniconda
12+
- export PATH="$HOME/miniconda/bin:$PATH"
13+
- hash -r
14+
- conda config --set always_yes yes
15+
- conda update -q conda
16+
- conda install conda-build anaconda-client pytest pytest-cov
17+
- conda config --set auto_update_conda no
18+
- conda build conda.recipe --no-test
19+
- conda install --use-local planets
20+
- conda info -a
21+
22+
script:
23+
- pytest -v --color=yes --cov=planets tests
24+
after_success:
25+
- conda install -c conda-forge codecov
26+
- codecov
27+
28+
29+
# After you create the Github repo and add it to Travis, run the
30+
# travis_pypi_setup.py script to finish PyPI deployment setup
31+
deploy:
32+
provider: pypi
33+
distributions: sdist bdist_wheel
34+
user: michaelaye
35+
password:
36+
secure: PLEASE_REPLACE_ME
37+
on:
38+
tags: true
39+
repo: michaelaye/planets

‎AUTHORS.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* K.-Michael Aye <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
.. highlight:: shell
2+
3+
============
4+
Contributing
5+
============
6+
7+
Contributions are welcome, and they are greatly appreciated! Every
8+
little bit helps, and credit will always be given.
9+
10+
You can contribute in many ways:
11+
12+
Types of Contributions
13+
----------------------
14+
15+
Report Bugs
16+
~~~~~~~~~~~
17+
18+
Report bugs at https://github.com/michaelaye/planets/issues.
19+
20+
If you are reporting a bug, please include:
21+
22+
* Your operating system name and version.
23+
* Any details about your local setup that might be helpful in troubleshooting.
24+
* Detailed steps to reproduce the bug.
25+
26+
Fix Bugs
27+
~~~~~~~~
28+
29+
Look through the GitHub issues for bugs. Anything tagged with "bug"
30+
and "help wanted" is open to whoever wants to implement it.
31+
32+
Implement Features
33+
~~~~~~~~~~~~~~~~~~
34+
35+
Look through the GitHub issues for features. Anything tagged with "enhancement"
36+
and "help wanted" is open to whoever wants to implement it.
37+
38+
Write Documentation
39+
~~~~~~~~~~~~~~~~~~~
40+
41+
planets could always use more documentation, whether as part of the
42+
official planets docs, in docstrings, or even on the web in blog posts,
43+
articles, and such.
44+
45+
Submit Feedback
46+
~~~~~~~~~~~~~~~
47+
48+
The best way to send feedback is to file an issue at https://github.com/michaelaye/planets/issues.
49+
50+
If you are proposing a feature:
51+
52+
* Explain in detail how it would work.
53+
* Keep the scope as narrow as possible, to make it easier to implement.
54+
* Remember that this is a volunteer-driven project, and that contributions
55+
are welcome :)
56+
57+
Get Started!
58+
------------
59+
60+
Ready to contribute? Here's how to set up `planets` for local development.
61+
62+
1. Fork the `planets` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone [email protected]:your_name_here/planets.git
66+
67+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68+
69+
$ mkvirtualenv planets
70+
$ cd planets/
71+
$ python setup.py develop
72+
73+
4. Create a branch for local development::
74+
75+
$ git checkout -b name-of-your-bugfix-or-feature
76+
77+
Now you can make your changes locally.
78+
79+
5. When you're done making changes, check that your changes pass flake8 and the tests::
80+
81+
$ flake8 planets tests
82+
$ python setup.py test or py.test
83+
84+
To get flake8, just pip install them into your conda env.
85+
86+
6. Commit your changes and push your branch to GitHub::
87+
88+
$ git add .
89+
$ git commit -m "Your detailed description of your changes."
90+
$ git push origin name-of-your-bugfix-or-feature
91+
92+
7. Submit a pull request through the GitHub website.
93+
94+
Pull Request Guidelines
95+
-----------------------
96+
97+
Before you submit a pull request, check that it meets these guidelines:
98+
99+
1. The pull request should include tests.
100+
2. If the pull request adds functionality, the docs should be updated. Put
101+
your new functionality into a function with a docstring, and add the
102+
feature to the list in README.rst.
103+
3. The pull request should work for Python 3.7. Check
104+
https://travis-ci.org/michaelaye/planets/pull_requests
105+
and make sure that the tests pass for all supported Python versions.
106+
107+
Tips
108+
----
109+
110+
To run a subset of tests::
111+
112+
$ py.test tests.test_planets
113+

‎HISTORY.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======
2+
History
3+
=======
4+
5+
0.1.0 (2019-05-22)
6+
------------------
7+
8+
* First release on PyPI.

‎LICENSE

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
MIT License
3+
4+
Copyright (c) 2019, K.-Michael Aye
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7+
8+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9+
10+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
11+

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

0 commit comments

Comments
 (0)