Metadata-Version: 2.1
Name: create-pypkg
Version: 0.2.0
Summary: Python package scaffold builder
Author-email: Daichi Narushima <dnarsil+github@gmail.com>
Maintainer-email: Daichi Narushima <dnarsil+github@gmail.com>
License: MIT License
        
        Copyright (c) 2019 Daichi Narushima
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/dceoy/create-pypkg.git
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: docopt>=0.6.2
Requires-Dist: jinja2>=3.1.2

create-pypkg
============

Python Package Scaffold Builder

[![Test](https://github.com/dceoy/create-pypkg/actions/workflows/test.yml/badge.svg)](https://github.com/dceoy/create-pypkg/actions/workflows/test.yml)
[![CI to Docker Hub](https://github.com/dceoy/create-pypkg/actions/workflows/docker-compose-build-and-push.yml/badge.svg)](https://github.com/dceoy/create-pypkg/actions/workflows/docker-compose-build-and-push.yml)
[![Release on PyPI](https://github.com/dceoy/create-pypkg/actions/workflows/python-package-release-on-pypi-and-github.yml/badge.svg)](https://github.com/dceoy/create-pypkg/actions/workflows/python-package-release-on-pypi-and-github.yml)

Installation
------------

```sh
$ pip install -U create-pypkg
```

Docker image
------------

The image is available at [Docker Hub](https://hub.docker.com/r/dceoy/create-pypkg/).

```sh
$ docker image pull dceoy/create-pypkg
```

Usage
-----

1.  Create a new package.

    Replace `newpackage` below with your package's name.

    ```sh
    $ mkdir newpackage
    $ create-pypkg ./newpackage
    ```

2.  Test the command-line interface of the package. (optional)

    ```sh
    $ python -m venv venv
    $ source venv/bin/activate
    $ pip install -U ./newpackage
    $ newpackage --help
    $ newpackage --debug foo bar
    ```

Run `create-pypkg --help` for more information.
