Blankslate
Blankslate automates the creation of Python projects, ensuring that every detail adheres to the best practices of Python development. It leverages GitHub Actions, NumPy docstrings, and a well-organised directory structure to deliver a ready-to-deploy project scaffold.
Installation
To install Blankslate, simply run:
pip install blankslate-python
Getting Started
After installation, you can create a new project by executing:
blankslate-python
Follow the prompts to specify your project details. Blankslate will create the project in your designated directory. You can then push this project to GitHub and start programming in the source/PROJECT_NAME/ directory.
Features
- Automatic Project Structure Creation: Sets up a GitHub-ready Python project with best practices.
- Semantic Versioning: Use the script
./scripts/release.sh VERSION_NUMBERto auto-version and generate a changelog. EnsureVERSION_NUMBERfollows semantic versioning. Note that this will automatically build and publish the project to PyPi, too. - Commit Style: Commits should follow the Angular commit style.
- Documentation: Automatically generates and pushes documentation to GitHub pages. Make sure your GitHub repository is configured under
Settings -> Pagesand set the deployment branch todocs/(root). - TODO to GitHub Issues: Converts
# TODOcomments in your Python code into GitHub issues. Configure this inSettings -> Actions (General) -> Workflow permissionsand enable "Read and write permissions".
Extensions
Enhance your Blankslate experience with the Blankslate Extension Pack for VS Code.
Contributing
Contributions are welcome! Please refer to our CONTRIBUTING.md for more information.
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
1 maintainer
Metadata
1 maintainer
Release files for blankslate-python 1.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| blankslate_python-1.3.5.tar.gz | 21.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| blankslate_python-1.3.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.6 kB
Release files / blankslate_python-1.3.5.tar.gz
| Download URL | blankslate_python-1.3.5.tar.gz |
|---|---|
| Size | 21.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
699071762347b57dfe80b7155a2799a4c822ede601d51a241dfc89e5c97a0863
|
|
BLAKE2b-256 checksum How to use checksums |
224e6a8bc8a82ef3d15e832cbb1acab4ae794df7126d79a2680a32c9a906f6f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.12.1 Windows/10
|
Release files / blankslate_python-1.3.5-py3-none-any.whl
| Download URL | blankslate_python-1.3.5-py3-none-any.whl |
|---|---|
| Size | 31.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
24cf7c15070e57dca0572478eca9ba6c09a33a380b5721178f16d4f00e62a449
|
|
BLAKE2b-256 checksum How to use checksums |
d31bec6aa9741035ec2e688a9261fa4f09ac8ce0335ca30183b40305e3064b3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.12.1 Windows/10
|
Security for blankslate-python 1.3.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
