# create-python-cmd
[![Linting](https://github.com/zackees/createpythonapp/actions/workflows/lint.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/lint.yml)
[![MacOS_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_macos.yml)
[![Ubuntu_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_ubuntu.yml)
[![Win_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_win.yml)
This is a command for creating a skeleton project for python commands. It uses
uv to boot strap the project and install an environment. Helpful utilities for
installing the project are given, wee below.
Template that this uses is here:
* https://github.com/zackees/template-python-cmd
```python
> pip install create-python-cmd
> git clone https://github.com/.../myproject
> cd myproject
> createpythoncmd # Creates a new Python command line application.
```
Creates a new Python command line application with linters and tests.
# Tools
The following tools will be installed
* `install` - script to boot strap and install the python package
* `clean` - removes build artifacts
* `lint` - runs the linters on the source code
* `test` - runs the unit test
# Linters
The following linters are used
* `ruff`
* `black`
* `isort`
* `mypy`
# Uploading your project to PYPI
To upload your project to pypi simply run `. ./upload_package.sh`
# Versions
* `2.0.0` - Moved to the uv build system as this is much better and fixes the boot strapping of python issue. Fixes git bash not being cd'd to the current directory in VSCode.
* `1.2.5` - Varius fixes and test fixes.
* `1.2.2` - Adds retries to get correct parameters and auto corrects parameters instead of exiting.
* `1.2.0` - Refresh with new modern practices like an installation script.
* `1.1.1` - Adds chmod +x to shell scripts and adds post install instructions.
* `1.1.0` - createpythonapp -> createpythoncmd.
* `1.0.9` - Adds keywords prompt during setup.
Raw data
{
"_id": null,
"home_page": "https://github.com/zackees/create-python-cmd",
"name": "create-python-cmd",
"maintainer": "Zachary Vorhies",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "create python cmd",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/06/8a/a06fdc3e8324439af9705ec53092b0b596b2611f0afb24fb65dd3f484128/create-python-cmd-2.0.0.tar.gz",
"platform": null,
"description": "# create-python-cmd\r\n\r\n[![Linting](https://github.com/zackees/createpythonapp/actions/workflows/lint.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/lint.yml)\r\n\r\n[![MacOS_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_macos.yml)\r\n[![Ubuntu_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_ubuntu.yml)\r\n[![Win_Tests](https://github.com/zackees/createpythonapp/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/createpythonapp/actions/workflows/push_win.yml)\r\n\r\n\r\nThis is a command for creating a skeleton project for python commands. It uses\r\nuv to boot strap the project and install an environment. Helpful utilities for\r\ninstalling the project are given, wee below.\r\n\r\nTemplate that this uses is here:\r\n * https://github.com/zackees/template-python-cmd\r\n\r\n```python\r\n> pip install create-python-cmd\r\n> git clone https://github.com/.../myproject\r\n> cd myproject\r\n> createpythoncmd # Creates a new Python command line application.\r\n```\r\n\r\nCreates a new Python command line application with linters and tests.\r\n\r\n# Tools\r\n\r\nThe following tools will be installed\r\n * `install` - script to boot strap and install the python package\r\n * `clean` - removes build artifacts\r\n * `lint` - runs the linters on the source code\r\n * `test` - runs the unit test\r\n\r\n# Linters\r\n\r\nThe following linters are used\r\n * `ruff`\r\n * `black`\r\n * `isort`\r\n * `mypy`\r\n\r\n\r\n# Uploading your project to PYPI\r\n\r\nTo upload your project to pypi simply run `. ./upload_package.sh`\r\n\r\n# Versions\r\n * `2.0.0` - Moved to the uv build system as this is much better and fixes the boot strapping of python issue. Fixes git bash not being cd'd to the current directory in VSCode.\r\n * `1.2.5` - Varius fixes and test fixes.\r\n * `1.2.2` - Adds retries to get correct parameters and auto corrects parameters instead of exiting.\r\n * `1.2.0` - Refresh with new modern practices like an installation script.\r\n * `1.1.1` - Adds chmod +x to shell scripts and adds post install instructions.\r\n * `1.1.0` - createpythonapp -> createpythoncmd.\r\n * `1.0.9` - Adds keywords prompt during setup.\r\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Cross platform(ish) productivity commands written in python.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/zackees/create-python-cmd"
},
"split_keywords": [
"create",
"python",
"cmd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7354506627595f936265322056d06d7f81a9ad196ff669eb709cc10e38fc34c",
"md5": "aa08272ade3459a069359953d65d9367",
"sha256": "e807ed02c89222d305bd53c8ee7fdaac7a9c26fbf4a111ab7db53b5bf60e36d8"
},
"downloads": -1,
"filename": "create_python_cmd-2.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa08272ade3459a069359953d65d9367",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 6224,
"upload_time": "2024-10-27T02:59:44",
"upload_time_iso_8601": "2024-10-27T02:59:44.156467Z",
"url": "https://files.pythonhosted.org/packages/e7/35/4506627595f936265322056d06d7f81a9ad196ff669eb709cc10e38fc34c/create_python_cmd-2.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "068aa06fdc3e8324439af9705ec53092b0b596b2611f0afb24fb65dd3f484128",
"md5": "72d04bdb0060164ce69b713ef05d87c8",
"sha256": "42b2132323f99f972ed1795ae1ea22c6314080ac31ecc04140d372cd9bb7c328"
},
"downloads": -1,
"filename": "create-python-cmd-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "72d04bdb0060164ce69b713ef05d87c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11530,
"upload_time": "2024-10-27T02:59:45",
"upload_time_iso_8601": "2024-10-27T02:59:45.469370Z",
"url": "https://files.pythonhosted.org/packages/06/8a/a06fdc3e8324439af9705ec53092b0b596b2611f0afb24fb65dd3f484128/create-python-cmd-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 02:59:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zackees",
"github_project": "create-python-cmd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "create-python-cmd"
}