pygen-scaffold

Name	pygen-scaffold JSON
Version	0.1.0 JSON
	download
home_page
Summary	A python program for scaffolding python projects.
upload_time	2022-12-19 23:37:15
maintainer
docs_url	None
author
requires_python	>=3.10
license
keywords	scaffold
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # pygen-scaffold

A python program for scaffolding python projects.

![Test](https://github.com/ocrosby/pygen-scaffold/actions/workflows/ci.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/ocrosby/pygen-scaffold/badge.svg?branch=feature/init)](https://coveralls.io/github/ocrosby/pygen-scaffold?branch=feature/init)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)



## Setup

### Step 1. Create a virtual environment

You only need to do this once, if you've done it before for this project, you can skip this step.

```bash 
python3 -m venv venv
```

### Step 2. Activate the virtual environment

```bash
source venv/bin/activate
```

### Step 3. Upgrade PIP

```bash
pip install --upgrade pip
```

### Step 4. Install the dependencies

```bash
# Install the production dependencies
pip install -r requirements.txt

# Install development dependencies
pip install -r requirements-dev.txt
```


## Development Usage

### Clean transient files

```bash
inv clean
```

### Run the tests

```bash
inv test
```

### Generate Coverage Report

```bash
inv coverage
```

### Run the linter

```bash
inv lint
```

### Execute the build process

```bash
inv
```




## References
[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pygen-scaffold",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "scaffold",
    "author": "",
    "author_email": "Omar Crosby <omar.crosby@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/fe/4f/bd879a63b664abfb18e806d30f836a958bf6ce27de17267cf376da8909ba/pygen-scaffold-0.1.0.tar.gz",
    "platform": null,
    "description": "# pygen-scaffold\n\nA python program for scaffolding python projects.\n\n![Test](https://github.com/ocrosby/pygen-scaffold/actions/workflows/ci.yml/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/ocrosby/pygen-scaffold/badge.svg?branch=feature/init)](https://coveralls.io/github/ocrosby/pygen-scaffold?branch=feature/init)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n\n\n## Setup\n\n### Step 1. Create a virtual environment\n\nYou only need to do this once, if you've done it before for this project, you can skip this step.\n\n```bash \npython3 -m venv venv\n```\n\n### Step 2. Activate the virtual environment\n\n```bash\nsource venv/bin/activate\n```\n\n### Step 3. Upgrade PIP\n\n```bash\npip install --upgrade pip\n```\n\n### Step 4. Install the dependencies\n\n```bash\n# Install the production dependencies\npip install -r requirements.txt\n\n# Install development dependencies\npip install -r requirements-dev.txt\n```\n\n\n## Development Usage\n\n### Clean transient files\n\n```bash\ninv clean\n```\n\n### Run the tests\n\n```bash\ninv test\n```\n\n### Generate Coverage Report\n\n```bash\ninv coverage\n```\n\n### Run the linter\n\n```bash\ninv lint\n```\n\n### Execute the build process\n\n```bash\ninv\n```\n\n\n\n\n## References\n[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A python program for scaffolding python projects.",
    "version": "0.1.0",
    "split_keywords": [
        "scaffold"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d3054f886a4936ab481d048995d60ef7",
                "sha256": "1c43e0cac0b3a6320b343d5ce402451f6fcb2290d9517927dd2ed8ea75c4504d"
            },
            "downloads": -1,
            "filename": "pygen_scaffold-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d3054f886a4936ab481d048995d60ef7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 14538,
            "upload_time": "2022-12-19T23:37:13",
            "upload_time_iso_8601": "2022-12-19T23:37:13.806718Z",
            "url": "https://files.pythonhosted.org/packages/04/73/0b414a515b2da41ddc2d6e167d52f84b23d9d8cc013bea26c2aacec6468d/pygen_scaffold-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "302cb2d58e4f384366d0b156cde4d211",
                "sha256": "7ab06cf4b155779b415b7fb699dcad3aa5c5e1acea6218a44657964f43ce359f"
            },
            "downloads": -1,
            "filename": "pygen-scaffold-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "302cb2d58e4f384366d0b156cde4d211",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 14501,
            "upload_time": "2022-12-19T23:37:15",
            "upload_time_iso_8601": "2022-12-19T23:37:15.451319Z",
            "url": "https://files.pythonhosted.org/packages/fe/4f/bd879a63b664abfb18e806d30f836a958bf6ce27de17267cf376da8909ba/pygen-scaffold-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-19 23:37:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pygen-scaffold"
}