This repository has been archived by the owner on Mar 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
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
6 changed files
with
16 additions
and
64 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 |
---|---|---|
|
@@ -26,15 +26,19 @@ If you are reporting a bug, please include: | |
Fix Bugs | ||
~~~~~~~~ | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
wanted" is open to whoever wants to implement it. | ||
Look through the GitHub issues for bugs. Anything tagged with "bug" | ||
and "help wanted" is open to whoever wants to implement a fix for 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. | ||
|
||
If you have a new feature in mind, please start it by filing an issue | ||
so we can discuss the need and approach before you invest time into | ||
coding it. | ||
|
||
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
@@ -47,7 +51,7 @@ Submit Feedback | |
|
||
The best way to send feedback is to file an issue at https://github.com/apiology/op-env/issues. | ||
|
||
If you are proposing a feature: | ||
If you are proposing a new feature: | ||
|
||
* Explain in detail how it would work. | ||
* Keep the scope as narrow as possible, to make it easier to implement. | ||
|
@@ -57,41 +61,8 @@ If you are proposing a feature: | |
Get Started! | ||
------------ | ||
|
||
Ready to contribute? Here's how to set up `op-env` for local development. | ||
|
||
1. Fork the `op-env` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/op-env.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 op-env | ||
$ cd op-env/ | ||
$ 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 op_env tests | ||
$ make test | ||
$ 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. | ||
Ready to contribute? See DEVELOPMENT.md in this directory for details | ||
on how to set yourself up for local development. | ||
|
||
Pull Request Guidelines | ||
----------------------- | ||
|
@@ -102,7 +73,7 @@ Before you submit a pull request, check that it meets these guidelines: | |
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.6, 3.7, 3.8, 3.9, and 3.10. Check | ||
3. The pull request should work for Python 3.7, 3.8, 3.9, and 3.10. Check | ||
https://app.circleci.com/pipelines/github/apiology/op-env | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
|
@@ -112,16 +83,3 @@ Tips | |
To run a subset of tests:: | ||
|
||
$ pytest tests.test_op_env | ||
|
||
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 | ||
|
||
CircleCI 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
History | ||
======= | ||
|
||
0.1.0 (2021-12-14) | ||
0.1.0 (2022-01-08) | ||
------------------ | ||
|
||
* First release on PyPI. |
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 |
---|---|---|
|
@@ -99,14 +99,13 @@ def initialize_options(self) -> None: | |
setup( | ||
author="Vince Broz", | ||
author_email='[email protected]', | ||
python_requires='>=3.6', | ||
python_requires='>=3.7', | ||
classifiers=[ | ||
'Development Status :: 2 - Pre-Alpha', | ||
'Intended Audience :: Developers', | ||
'License :: OSI Approved :: MIT License', | ||
'Natural Language :: English', | ||
'Programming Language :: Python :: 3', | ||
'Programming Language :: Python :: 3.6', | ||
'Programming Language :: Python :: 3.7', | ||
'Programming Language :: Python :: 3.8', | ||
'Programming Language :: Python :: 3.9', | ||
|