-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
18 changed files
with
290 additions
and
56 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 |
---|---|---|
@@ -1,36 +1,39 @@ | ||
{ | ||
"template": "https://github.com/bird-house/cookiecutter-birdhouse.git", | ||
"commit": "f157ea8419fd4e32a9e4d52e613c90c807190e7e", | ||
"skip": [ | ||
"emu/processes/wps_say_hello.py", | ||
"tests/test_wps_hello.py", | ||
"docs/source/notebooks/example.ipynb", | ||
"environment.yml", | ||
"requirements.txt", | ||
"AUTHORS.rst", | ||
"CHANGES.rst", | ||
"docs/source/notebooks/index.rst", | ||
"docs/source/processes.rst", | ||
"emu/processes/__init__.py", | ||
"tests/test_wps_caps.py" | ||
], | ||
"context": { | ||
"cookiecutter": { | ||
"full_name": "Carsten Ehbrecht", | ||
"email": "[email protected]", | ||
"github_username": "bird-house", | ||
"project_name": "Emu", | ||
"project_slug": "emu", | ||
"project_repo_name": "emu", | ||
"project_readthedocs_name": "emu", | ||
"project_short_description": "WPS processes for testing and demos.", | ||
"version": "0.12.0", | ||
"open_source_license": "Apache Software License 2.0", | ||
"http_port": "5000", | ||
"_copy_without_render": [ | ||
"{{cookiecutter.project_slug}}/templates/*.cfg" | ||
], | ||
"_template": "https://github.com/bird-house/cookiecutter-birdhouse.git" | ||
} | ||
"template": "https://github.com/bird-house/cookiecutter-birdhouse.git", | ||
"commit": "bc8a389e02a3e55e55dad7657671d91e2f238ed9", | ||
"skip": [ | ||
"emu/processes/wps_say_hello.py", | ||
"tests/test_wps_hello.py", | ||
"docs/source/notebooks/example.ipynb", | ||
"environment.yml", | ||
"requirements.txt", | ||
"AUTHORS.rst", | ||
"CHANGES.rst", | ||
"docs/source/notebooks/index.rst", | ||
"docs/source/processes.rst", | ||
"emu/processes/__init__.py", | ||
"tests/test_wps_caps.py" | ||
], | ||
"context": { | ||
"cookiecutter": { | ||
"full_name": "Carsten Ehbrecht", | ||
"email": "[email protected]", | ||
"github_username": "bird-house", | ||
"project_name": "Emu", | ||
"project_slug": "emu", | ||
"project_repo_name": "emu", | ||
"project_readthedocs_name": "emu", | ||
"project_short_description": "WPS processes for testing and demos.", | ||
"version": "0.12.0", | ||
"open_source_license": "Apache Software License 2.0", | ||
"http_port": "5000", | ||
"use_pytest": "y", | ||
"create_author_file": "y", | ||
"_copy_without_render": [ | ||
"{{cookiecutter.project_slug}}/templates/*.cfg" | ||
], | ||
"_template": "https://github.com/bird-house/cookiecutter-birdhouse.git" | ||
} | ||
} | ||
}, | ||
"checkout": null | ||
} |
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 |
---|---|---|
@@ -0,0 +1,128 @@ | ||
.. highlight:: shell | ||
|
||
============ | ||
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every little bit | ||
helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
Types of Contributions | ||
---------------------- | ||
|
||
Report Bugs | ||
~~~~~~~~~~~ | ||
|
||
Report bugs at https://github.com/bird-house/emu/issues. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
* Your operating system name and version. | ||
* Any details about your local setup that might be helpful in troubleshooting. | ||
* Detailed steps to reproduce the bug. | ||
|
||
Fix Bugs | ||
~~~~~~~~ | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
wanted" is open to whoever wants to implement it. | ||
|
||
Implement Features | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
and "help wanted" is open to whoever wants to implement it. | ||
|
||
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Emu could always use more documentation, whether as part of the | ||
official Emu 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/bird-house/emu/issues. | ||
|
||
If you are proposing a feature: | ||
|
||
* Explain in detail how it would work. | ||
* Keep the scope as narrow as possible, to make it easier to implement. | ||
* Remember that this is a volunteer-driven project, and that contributions | ||
are welcome :) | ||
|
||
Get Started! | ||
------------ | ||
|
||
Ready to contribute? Here's how to set up `emu` for local development. | ||
|
||
1. Fork the `emu` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/emu.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 emu | ||
$ cd emu/ | ||
$ python setup.py develop | ||
|
||
4. Create a branch for local development:: | ||
|
||
$ git checkout -b name-of-your-bugfix-or-feature | ||
|
||
Now you can make your changes locally. | ||
|
||
5. When you're done making changes, check that your changes pass flake8 and the | ||
tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 emu tests | ||
$ python setup.py test or pytest | ||
$ tox | ||
|
||
To get flake8 and tox, just pip install them into your virtualenv. | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
|
||
7. Submit a pull request through the GitHub website. | ||
|
||
Pull Request Guidelines | ||
----------------------- | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
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/bird-house/emu/pull_requests | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
---- | ||
|
||
To run a subset of tests:: | ||
|
||
$ pytest tests.test_emu | ||
|
||
|
||
Deploying | ||
--------- | ||
|
||
A reminder for the maintainers on how to deploy. | ||
Make sure all your changes are committed (including an entry in HISTORY.rst). | ||
Then run:: | ||
|
||
$ bump2version patch # possible: major / minor / patch | ||
$ git push | ||
$ git push --tags | ||
|
||
Travis will then deploy to PyPI if tests pass. |
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,6 +1,7 @@ | ||
include Makefile | ||
include *.txt | ||
include *.rst | ||
include tox.ini | ||
recursive-include emu * | ||
global-exclude __pycache__ | ||
global-exclude *.py[co] |
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 @@ | ||
.. include:: ../../AUTHORS.rst |
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 |
---|---|---|
|
@@ -9,6 +9,7 @@ | |
dev_guide | ||
tutorial | ||
processes | ||
authors | ||
changes | ||
|
||
Indices and tables | ||
|
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 |
---|---|---|
|
@@ -4,6 +4,6 @@ | |
# without importing the main package when its dependencies are not installed. | ||
# See: https://packaging.python.org/guides/single-sourcing-package-version | ||
|
||
__author__ = """Carsten Ehbrecht""" | ||
__email__ = '[email protected]' | ||
__version__ = '0.12.0' | ||
__author__ = "Carsten Ehbrecht" | ||
__email__ = "[email protected]" | ||
__version__ = "0.12.0" |
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
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,5 +1,4 @@ | ||
#!/usr/bin/env python | ||
# -*- coding: utf-8 -*- | ||
|
||
"""The setup script.""" | ||
|
||
|
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,3 +1 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
"""Unit test package for emu.""" |
Oops, something went wrong.