@@ -218,25 +218,25 @@ Contributions in the form of patches, tests and feature creation and/or
218
218
requests are very welcome and highly encouraged. Please open an issue if this
219
219
tool does not function as you'd expect.
220
220
221
-
222
- ### How to release updates
223
- If this is the first time you're releasing to pypi,
224
- you'll need to run: ` ` pip install -r tests/dev_requirements.txt ` ` .
225
-
226
- Once complete, execute the following commands:
227
-
228
- ` ` ` bash
229
- git checkout master
230
-
231
- # Increment the version number and tag the release.
232
- bumpversion [major|minor|patch]
233
-
234
- # Upload the distribution to PyPi
235
- python setup.py sdist bdist_wheel upload
236
-
237
- # Since master often contains work-in-progress changes, increment the version
238
- # to a patch release to prevent inaccurate attribution.
239
- bumpversion --no-tag patch
240
-
241
- git push origin master --tags
242
- ```
221
+ ### Environment Setup
222
+ 1. [Install pipenv](https://github.com/pypa/pipenv)
223
+ 2. [Install direnv](https://direnv.net/)
224
+ 3. [Install Precommit](https://pre-commit.com/# install) (optional but preferred)
225
+ 4. ` ` cd ` ` into the project and enter "direnv allow" when prompted. This will begin
226
+ installing all the development dependancies.
227
+ 5. If you installed pre-commit, run ` ` pre-commit install ` ` inside the project
228
+ directory to setup the githooks.
229
+
230
+ ### Releasing to Pypi
231
+ Once you pushed your chances to master, run **one** of the following:
232
+
233
+ ` ` ` sh
234
+ # If you're installing a major release:
235
+ make deploy-major
236
+
237
+ # If you're installing a minor release:
238
+ make deploy-minor
239
+
240
+ # If you're installing a patch release:
241
+ make deploy-patch
242
+ ```
0 commit comments