py-starter-auto-template


Namepy-starter-auto-template JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryCreating a template Python package with a CLI interface.
upload_time2024-01-24 22:41:39
maintainer
docs_urlNone
authorShaofeng Kang
requires_python>3.11
license
keywords python starter template cli version control python-starter python-starter-template python-starter-cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PythonStarter
 Auto-generate starter template of python3 and create env

# Install
```bash
 pip install py-starter-auto-template
```

# Usage
## To create a project base template with bump2version managing versioning
```bash
  pyinit -m create <project_name> 
```
In your project folder, it will create 
```bash
  package_name/
  |-- src/
  |   |-- __init__.py
  |-- tests/
  |   |-- test_placeholder.py
  |-- .bumpversion.cfg
  |-- .gitattributes
  |-- .girigore
  |-- MANIFEST.in
  |-- pytest.ini
  |-- setup.py
```

## To create github/workflows
```bash
  pyinit -m create <project_name> -i ci 
```

It will create
```bash
.github/
  |-- workflows/
  |   |-- <project_name>_ci.yml

```





            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "py-starter-auto-template",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">3.11",
    "maintainer_email": "",
    "keywords": "python starter template cli version control python-starter python-starter-template python-starter-cli",
    "author": "Shaofeng Kang",
    "author_email": "robkangshaofeng@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/5d/bee93311c5663f0f3ae958723478841ccffc524221b6b4ddcf074fd410d0/py_starter_auto_template-0.0.2.tar.gz",
    "platform": null,
    "description": "# PythonStarter\n Auto-generate starter template of python3 and create env\n\n# Install\n```bash\n pip install py-starter-auto-template\n```\n\n# Usage\n## To create a project base template with bump2version managing versioning\n```bash\n  pyinit -m create <project_name> \n```\nIn your project folder, it will create \n```bash\n  package_name/\n  |-- src/\n  |   |-- __init__.py\n  |-- tests/\n  |   |-- test_placeholder.py\n  |-- .bumpversion.cfg\n  |-- .gitattributes\n  |-- .girigore\n  |-- MANIFEST.in\n  |-- pytest.ini\n  |-- setup.py\n```\n\n## To create github/workflows\n```bash\n  pyinit -m create <project_name> -i ci \n```\n\nIt will create\n```bash\n.github/\n  |-- workflows/\n  |   |-- <project_name>_ci.yml\n\n```\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Creating a template Python package with a CLI interface.",
    "version": "0.0.2",
    "project_urls": null,
    "split_keywords": [
        "python",
        "starter",
        "template",
        "cli",
        "version",
        "control",
        "python-starter",
        "python-starter-template",
        "python-starter-cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "841535719cf3870df8fde7f7c40f1ab75ea5148633738cbed0cea6698ecec9fa",
                "md5": "908e744cf62cdeba2923c6438a024e8e",
                "sha256": "6e7acee70e3d577934784cabe8b3bd41358c8455356a3b2a4f41a88de534456b"
            },
            "downloads": -1,
            "filename": "py_starter_auto_template-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "908e744cf62cdeba2923c6438a024e8e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.11",
            "size": 7994,
            "upload_time": "2024-01-24T22:41:37",
            "upload_time_iso_8601": "2024-01-24T22:41:37.785618Z",
            "url": "https://files.pythonhosted.org/packages/84/15/35719cf3870df8fde7f7c40f1ab75ea5148633738cbed0cea6698ecec9fa/py_starter_auto_template-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e5dbee93311c5663f0f3ae958723478841ccffc524221b6b4ddcf074fd410d0",
                "md5": "1fe838dd9c465dc6bd6cde300aecb850",
                "sha256": "e74a85dc815501efb61e88ad9a4fdb99ad15c4eab674f5fecb5aa054522f196b"
            },
            "downloads": -1,
            "filename": "py_starter_auto_template-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1fe838dd9c465dc6bd6cde300aecb850",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.11",
            "size": 6304,
            "upload_time": "2024-01-24T22:41:39",
            "upload_time_iso_8601": "2024-01-24T22:41:39.284525Z",
            "url": "https://files.pythonhosted.org/packages/5e/5d/bee93311c5663f0f3ae958723478841ccffc524221b6b4ddcf074fd410d0/py_starter_auto_template-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-24 22:41:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "py-starter-auto-template"
}
        
Elapsed time: 0.20709s