Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

Commit

Permalink
Update template
Browse files Browse the repository at this point in the history
  • Loading branch information
apiology committed Jan 9, 2022
1 parent 14c3af9 commit 551de16
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 64 deletions.
62 changes: 10 additions & 52 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~

Expand All @@ -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.
Expand All @@ -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
-----------------------
Expand All @@ -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.

Expand All @@ -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.
2 changes: 1 addition & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
History
=======

0.1.0 (2021-12-14)
0.1.0 (2022-01-08)
------------------

* First release on PyPI.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021, Vince Broz
Copyright (c) 2022, Vince Broz

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

# General information about the project.
project = 'op-env'
copyright = "2021, Vince Broz"
copyright = "2022, Vince Broz"
author = "Vince Broz"

# The version info for the project you're documenting, acts as replacement
Expand Down
9 changes: 2 additions & 7 deletions fix.sh
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ ensure_python_build_requirements() {
ensure_python_versions() {
# You can find out which feature versions are still supported / have
# been release here: https://www.python.org/downloads/
python_versions="$(latest_python_version 3.10) $(latest_python_version 3.9) $(latest_python_version 3.8) $(latest_python_version 3.7) $(latest_python_version 3.6)"
python_versions="$(latest_python_version 3.10) $(latest_python_version 3.9) $(latest_python_version 3.8) $(latest_python_version 3.7)"

echo "Latest Python versions: ${python_versions}"

Expand All @@ -284,12 +284,7 @@ ensure_python_versions() {
}

major_minor="$(cut -d. -f1-2 <<<"${ver}")"
if [ "${major_minor}" == 3.6 ]
then
pyenv_install --patch "${ver}" < <(curl -sSL https://github.com/python/cpython/commit/8ea6353.patch\?full_index=1)
else
pyenv_install "${ver}"
fi
pyenv_install "${ver}"
else
pyenv install -s "${ver}"
fi
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 551de16

Please sign in to comment.