# 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:
```bash
pip install blankslate-python
```
## Getting Started
After installation, you can create a new project by executing:
```bash
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](https://semver.org). Note that this will automatically build and publish the project to PyPi, too.
- **Commit Style**: Commits should follow the [Angular commit style](https://gist.github.com/brianclements/841ea7bffdb01346392c#commit-message-header).
- **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](https://marketplace.visualstudio.com/items?itemName=unkokaeru.blankslate-extension-pack) for [VS Code](https://code.visualstudio.com/download).
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/unkokaeru/blankslate",
"name": "blankslate-python",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "William Fayers",
"author_email": "wills@fayers.com",
"download_url": "https://files.pythonhosted.org/packages/22/4e/6a8bc8a82ef3d15e832cbb1acab4ae794df7126d79a2680a32c9a906f6f4/blankslate_python-1.3.5.tar.gz",
"platform": null,
"description": "# Blankslate\n\n\n\nBlankslate 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.\n\n## Installation\n\nTo install Blankslate, simply run:\n\n```bash\npip install blankslate-python\n```\n\n## Getting Started\n\nAfter installation, you can create a new project by executing:\n\n```bash\nblankslate-python\n```\n\nFollow 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.\n\n## Features\n\n- **Automatic Project Structure Creation**: Sets up a GitHub-ready Python project with best practices.\n- **Semantic Versioning**: Use the script `./scripts/release.sh VERSION_NUMBER` to auto-version and generate a changelog. Ensure `VERSION_NUMBER` follows [semantic versioning](https://semver.org). Note that this will automatically build and publish the project to PyPi, too.\n- **Commit Style**: Commits should follow the [Angular commit style](https://gist.github.com/brianclements/841ea7bffdb01346392c#commit-message-header).\n- **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)`.\n- **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\".\n\n## Extensions\n\nEnhance your Blankslate experience with the [Blankslate Extension Pack](https://marketplace.visualstudio.com/items?itemName=unkokaeru.blankslate-extension-pack) for [VS Code](https://code.visualstudio.com/download).\n\n## Contributing\n\nContributions are welcome! Please refer to our `CONTRIBUTING.md` for more information.\n\n## License\n\nThis project is licensed under the MIT License - see the `LICENSE.md` file for details.",
"bugtrack_url": null,
"license": "MIT",
"summary": "A blank slate for Python projects",
"version": "1.3.5",
"project_urls": {
"Homepage": "https://github.com/unkokaeru/blankslate",
"Repository": "https://github.com/unkokaeru/blankslate"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d31bec6aa9741035ec2e688a9261fa4f09ac8ce0335ca30183b40305e3064b3f",
"md5": "cd2b156bdfb293d653cab265f2d87885",
"sha256": "24cf7c15070e57dca0572478eca9ba6c09a33a380b5721178f16d4f00e62a449"
},
"downloads": -1,
"filename": "blankslate_python-1.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd2b156bdfb293d653cab265f2d87885",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 31808,
"upload_time": "2024-05-06T14:30:06",
"upload_time_iso_8601": "2024-05-06T14:30:06.816079Z",
"url": "https://files.pythonhosted.org/packages/d3/1b/ec6aa9741035ec2e688a9261fa4f09ac8ce0335ca30183b40305e3064b3f/blankslate_python-1.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "224e6a8bc8a82ef3d15e832cbb1acab4ae794df7126d79a2680a32c9a906f6f4",
"md5": "c117cfc46684c32e5646de4dae68fa20",
"sha256": "699071762347b57dfe80b7155a2799a4c822ede601d51a241dfc89e5c97a0863"
},
"downloads": -1,
"filename": "blankslate_python-1.3.5.tar.gz",
"has_sig": false,
"md5_digest": "c117cfc46684c32e5646de4dae68fa20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21798,
"upload_time": "2024-05-06T14:30:08",
"upload_time_iso_8601": "2024-05-06T14:30:08.633737Z",
"url": "https://files.pythonhosted.org/packages/22/4e/6a8bc8a82ef3d15e832cbb1acab4ae794df7126d79a2680a32c9a906f6f4/blankslate_python-1.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 14:30:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "unkokaeru",
"github_project": "blankslate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Jinja2",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"12.11.0"
]
]
}
],
"tox": true,
"lcname": "blankslate-python"
}
JSON
