Create Python projects easily using well-defined templates.
Project description
pyquickstart
Create Python projects easily using well-defined templates.
Features
- Intuitive Python project creation
- Well-defined standard template
Standard template
We use this template for our own projects following modern best practices:
- Linting with flake8
- Testing automation with pytest and tox for current Python releases
- Measuring code coverage using coverage
- Continuous integration on Gitlab
- Packaging as wheel
- Deployment on PyPI using twine
Technical requirements
Below is the list of currently supported Python releases:
# | Python |
---|---|
1 | 3.6 |
2 | 3.7 |
3 | 3.8 |
Code and contribution
The code is open source and released under the MIT License (MIT). It is available on Gitlab and follows the guidelines about Semantic Versioning for transparency within the release cycle and backward compatibility whenever possible.
All contributions are welcome, whether bug reports, reviews, documentation or feature requests.
If you're a developer and have time and ideas for code contributions, fork the repo and prepare a merge request:
# Prepare your environment the first time
mkvirtualenv --python=python3.6 pyquickstart-py36
pip install -e .[development]
# Running the tests while development
pytest
# Individual Python release tests and code quality checks
tox -e py36
tox -e coverage
tox -e flake8
# Ensure code quality running the entire test suite,
# this requires all supported Python releases to be installed
tox
Installation
Install pyquickstart
using pip
:
pip install pyquickstart
Usage
Create a new Python project from the standard template in your current working directory by running pyquickstart
:
pyquickstart
Then answer a few simple questions, default values in square brackets:
project [shinyprojectname]:
author [John Doe]:
author_email [john@example.com]:
repository_url [https://gitlab.com/johndoe/shinyprojectname]:
year [2020]:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for pyquickstart-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d772d9f5ec717b2bb7b7104d224e473dbe3c7a60bd812814b6ecc7f5854287a0 |
|
MD5 | c232427f680238b54c4c50c59ad07b29 |
|
BLAKE2b-256 | 532a3bb821f6ace5203bb428f035937c8606d4dac82a3e418966aec5d30b8bf3 |