blankslate-python 1.3.3

A blank slate for Python projects

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_NUMBER to auto-version and generate a changelog. Ensure VERSION_NUMBER follows 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 -> Pages and set the deployment branch to docs/(root).
• TODO to GitHub Issues: Converts # TODO comments in your Python code into GitHub issues. Configure this in Settings -> Actions (General) -> Workflow permissions and 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.