| Name | bryn-python-boilerplate JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | |
| Summary | Python Boilerplate contains all the boilerplate you need to create a Python package. |
| upload_time | 2024-02-21 12:33:41 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
python_boilerplate
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--- the "--8<--" html comments define what part of the README to add to the index page of the documentation -->
<!--- --8<-- [start:docs] -->
# Python Boilerplate (python_boilerplate)
[](https://github.com/brynpickering/python_boilerplate/actions/workflows/daily-scheduled-ci.yml)
[](https://brynpickering.github.io/python_boilerplate)
This is a test repo.
<!--- --8<-- [end:docs] -->
## Documentation
For more detailed instructions, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest).
## Installation
To install python_boilerplate
(indexed online as bryn_python_boilerplate), we recommend using the [mamba](https://mamba.readthedocs.io/en/latest/index.html) package manager:
### As a user
<!--- --8<-- [start:docs-install-user] -->
``` shell
mamba create -n python_boilerplate -c conda-forge -c brynpickering bryn_python_boilerplate
mamba activate python_boilerplate
```
<!--- --8<-- [end:docs-install-user] -->
### As a developer
<!--- --8<-- [start:docs-install-dev] -->
``` shell
git clone git@github.com:brynpickering/python_boilerplate.git
cd python_boilerplate
mamba create -n python_boilerplate -c conda-forge --file requirements/base.txt --file requirements/dev.txt
mamba activate python_boilerplate
pip install --no-deps -e .
```
<!--- --8<-- [end:docs-install-dev] -->
For more detailed instructions, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest/installation/).
## Contributing
There are many ways to contribute to python_boilerplate.
Before making contributions to the python_boilerplate source code, see our contribution guidelines and follow the [development install instructions](#as-a-developer).
If you plan to make changes to the code then please make regular use of the following tools to verify the codebase while you work:
- `pre-commit`: run `pre-commit install` in your command line to load inbuilt checks that will run every time you commit your changes.
The checks are: 1. check no large files have been staged, 2. lint python files for major errors, 3. format python files to conform with the [pep8 standard](https://peps.python.org/pep-0008/).
You can also run these checks yourself at any time to ensure staged changes are clean by simple calling `pre-commit`.
- `pytest` - run the unit test suite and check test coverage.
- `pytest -p memray -m "high_mem" --no-cov` (not available on Windows) - after installing memray (`mamba install memray pytest-memray`), test that memory and time performance does not exceed benchmarks.
For more information, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest/contributing/).
## Building the documentation
If you are unable to access the online documentation, you can build the documentation locally.
First, [install a development environment of python_boilerplate](https://brynpickering.github.io/python_boilerplate/latest/contributing/coding/), then deploy the documentation using [mike](https://github.com/jimporter/mike):
```
mike deploy develop
mike serve
```
Then you can view the documentation in a browser at http://localhost:8000/.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [arup-group/cookiecutter-pypackage](https://github.com/arup-group/cookiecutter-pypackage) project template.
Raw data
{
"_id": null,
"home_page": "",
"name": "bryn-python-boilerplate",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python_boilerplate",
"author": "",
"author_email": "Bryn Pickering <17178478+brynpickering@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/0e/1f/359cdb161986416aabac44573db5d203d490e7da182a89624cea04e32299/bryn_python_boilerplate-0.1.4.tar.gz",
"platform": null,
"description": "<!--- the \"--8<--\" html comments define what part of the README to add to the index page of the documentation -->\n<!--- --8<-- [start:docs] -->\n\n\n# Python Boilerplate (python_boilerplate)\n\n[](https://github.com/brynpickering/python_boilerplate/actions/workflows/daily-scheduled-ci.yml)\n[](https://brynpickering.github.io/python_boilerplate)\n\nThis is a test repo.\n\n<!--- --8<-- [end:docs] -->\n\n## Documentation\n\nFor more detailed instructions, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest).\n\n## Installation\n\nTo install python_boilerplate\n (indexed online as bryn_python_boilerplate), we recommend using the [mamba](https://mamba.readthedocs.io/en/latest/index.html) package manager:\n\n### As a user\n<!--- --8<-- [start:docs-install-user] -->\n\n\n``` shell\n\nmamba create -n python_boilerplate -c conda-forge -c brynpickering bryn_python_boilerplate\nmamba activate python_boilerplate\n\n```\n<!--- --8<-- [end:docs-install-user] -->\n\n### As a developer\n<!--- --8<-- [start:docs-install-dev] -->\n``` shell\ngit clone git@github.com:brynpickering/python_boilerplate.git\ncd python_boilerplate\nmamba create -n python_boilerplate -c conda-forge --file requirements/base.txt --file requirements/dev.txt\nmamba activate python_boilerplate\npip install --no-deps -e .\n```\n<!--- --8<-- [end:docs-install-dev] -->\nFor more detailed instructions, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest/installation/).\n\n## Contributing\n\nThere are many ways to contribute to python_boilerplate.\nBefore making contributions to the python_boilerplate source code, see our contribution guidelines and follow the [development install instructions](#as-a-developer).\n\nIf you plan to make changes to the code then please make regular use of the following tools to verify the codebase while you work:\n\n- `pre-commit`: run `pre-commit install` in your command line to load inbuilt checks that will run every time you commit your changes.\nThe checks are: 1. check no large files have been staged, 2. lint python files for major errors, 3. format python files to conform with the [pep8 standard](https://peps.python.org/pep-0008/).\nYou can also run these checks yourself at any time to ensure staged changes are clean by simple calling `pre-commit`.\n- `pytest` - run the unit test suite and check test coverage.\n- `pytest -p memray -m \"high_mem\" --no-cov` (not available on Windows) - after installing memray (`mamba install memray pytest-memray`), test that memory and time performance does not exceed benchmarks.\n\nFor more information, see our [documentation](https://brynpickering.github.io/python_boilerplate/latest/contributing/).\n\n## Building the documentation\n\nIf you are unable to access the online documentation, you can build the documentation locally.\nFirst, [install a development environment of python_boilerplate](https://brynpickering.github.io/python_boilerplate/latest/contributing/coding/), then deploy the documentation using [mike](https://github.com/jimporter/mike):\n\n```\nmike deploy develop\nmike serve\n```\n\nThen you can view the documentation in a browser at http://localhost:8000/.\n\n\n## Credits\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [arup-group/cookiecutter-pypackage](https://github.com/arup-group/cookiecutter-pypackage) project template.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Boilerplate contains all the boilerplate you need to create a Python package.",
"version": "0.1.4",
"project_urls": {
"changelog": "https://github.com/brynpickering/python_boilerplate/blob/main/CHANGELOG.md",
"documentation": "https://brynpickering.github.io/python_boilerplate",
"repository": "https://github.com/brynpickering/python_boilerplate"
},
"split_keywords": [
"python_boilerplate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b11d2bb2481f73bf48efd08c0094295b743371304f61f36f2fc06c482084c805",
"md5": "a6cb7b21caf3744e1301ec7c282c843e",
"sha256": "d63d4ffc2645b339503b715a2b2b3a2b5dfd4fb6361a078fbd34377de215bc09"
},
"downloads": -1,
"filename": "bryn_python_boilerplate-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6cb7b21caf3744e1301ec7c282c843e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4969,
"upload_time": "2024-02-21T12:33:39",
"upload_time_iso_8601": "2024-02-21T12:33:39.315195Z",
"url": "https://files.pythonhosted.org/packages/b1/1d/2bb2481f73bf48efd08c0094295b743371304f61f36f2fc06c482084c805/bryn_python_boilerplate-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e1f359cdb161986416aabac44573db5d203d490e7da182a89624cea04e32299",
"md5": "282eff6f82634163eadf1fde2c08f2eb",
"sha256": "05b6d72a942feaf29c7d1b7ceac3c9191eeb99031e301f8cdbbf09f44628802d"
},
"downloads": -1,
"filename": "bryn_python_boilerplate-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "282eff6f82634163eadf1fde2c08f2eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6269,
"upload_time": "2024-02-21T12:33:41",
"upload_time_iso_8601": "2024-02-21T12:33:41.147422Z",
"url": "https://files.pythonhosted.org/packages/0e/1f/359cdb161986416aabac44573db5d203d490e7da182a89624cea04e32299/bryn_python_boilerplate-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 12:33:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brynpickering",
"github_project": "python_boilerplate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bryn-python-boilerplate"
}
