create-pypi-skeleton


Namecreate-pypi-skeleton JSON
Version 0.0.7 PyPI version JSON
download
home_pageNone
SummaryThis module automatically creates a PyPI project skeleton for you so you don't have to do this manually.
upload_time2024-12-20 08:14:22
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# create_pypi_skeleton

This module automatically creates a PyPI project skeleton for you so you don't have to do this manually.

# Installation using pip
```
pip install create-pypi-skeleton
```

# How to use (from command line)
```
python -m create_pypi_skeleton your_module_name
```

# how to use (from Python script)
```python
from create_pypi_skeleton import create_pypi_skeleton

create_pypi_skeleton("your_module_name")
```

# Sample PyPI project skeleton 

```
Typical PyPI project skeleton given module_name="testing123"

testing123/                 
    src/                    # all code goes here
        testing123/         
            __init__.py     # main folder where users import functions from
        tests/              
            main.py         # unit tests go here
        __init__.py
    .gitignore              # files/folders written here are ignored by git
    LICENSE                 # license stuff
    pyproject.toml          # contains important config stuff for PyPI
    README.md               # tells users what your project is about
    upload.py               # helper script to upload project to PyPI
```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "create-pypi-skeleton",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Liu Zuo Lin <zlliu246@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/fd/65/106b7c4310c0c31019fd2e121b2e9f1e26c1be8d2ca2f2f095024d0661dd/create_pypi_skeleton-0.0.7.tar.gz",
    "platform": null,
    "description": "\n# create_pypi_skeleton\n\nThis module automatically creates a PyPI project skeleton for you so you don't have to do this manually.\n\n# Installation using pip\n```\npip install create-pypi-skeleton\n```\n\n# How to use (from command line)\n```\npython -m create_pypi_skeleton your_module_name\n```\n\n# how to use (from Python script)\n```python\nfrom create_pypi_skeleton import create_pypi_skeleton\n\ncreate_pypi_skeleton(\"your_module_name\")\n```\n\n# Sample PyPI project skeleton \n\n```\nTypical PyPI project skeleton given module_name=\"testing123\"\n\ntesting123/                 \n    src/                    # all code goes here\n        testing123/         \n            __init__.py     # main folder where users import functions from\n        tests/              \n            main.py         # unit tests go here\n        __init__.py\n    .gitignore              # files/folders written here are ignored by git\n    LICENSE                 # license stuff\n    pyproject.toml          # contains important config stuff for PyPI\n    README.md               # tells users what your project is about\n    upload.py               # helper script to upload project to PyPI\n```",
    "bugtrack_url": null,
    "license": null,
    "summary": "This module automatically creates a PyPI project skeleton for you so you don't have to do this manually.",
    "version": "0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/zlliu246/create_pypi_skeleton",
        "Issues": "https://github.com/zlliu246/create_pypi_skeleton/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "791f2007e9d30085b1b2310ef51cf570cab8e8f8f3fc4b01de7e52816e2f2d36",
                "md5": "75f971c8019fe01f044be30930f51284",
                "sha256": "c8f1f2e25e43d4167b0f91555dce927b19e0dcc5363f7c79f0eac68d14ec6e25"
            },
            "downloads": -1,
            "filename": "create_pypi_skeleton-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "75f971c8019fe01f044be30930f51284",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4234,
            "upload_time": "2024-12-20T08:14:21",
            "upload_time_iso_8601": "2024-12-20T08:14:21.263477Z",
            "url": "https://files.pythonhosted.org/packages/79/1f/2007e9d30085b1b2310ef51cf570cab8e8f8f3fc4b01de7e52816e2f2d36/create_pypi_skeleton-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd65106b7c4310c0c31019fd2e121b2e9f1e26c1be8d2ca2f2f095024d0661dd",
                "md5": "affa1eca702eb2ceffbad3e5fbf02b76",
                "sha256": "74a8759dc86f6d4c37e69b0dbc44b370301734da6731b4259a1eaf925cf38f81"
            },
            "downloads": -1,
            "filename": "create_pypi_skeleton-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "affa1eca702eb2ceffbad3e5fbf02b76",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3280,
            "upload_time": "2024-12-20T08:14:22",
            "upload_time_iso_8601": "2024-12-20T08:14:22.510684Z",
            "url": "https://files.pythonhosted.org/packages/fd/65/106b7c4310c0c31019fd2e121b2e9f1e26c1be8d2ca2f2f095024d0661dd/create_pypi_skeleton-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 08:14:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zlliu246",
    "github_project": "create_pypi_skeleton",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "create-pypi-skeleton"
}
        
Elapsed time: 0.35048s