Metadata-Version: 2.1
Name: create-pypkg
Version: 0.1.3
Summary: Python package scaffold builder
Home-page: https://github.com/dceoy/create-pypkg
Author: Daichi Narushima
Author-email: dnarsil+github@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

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)
[![Upload Python Package](https://github.com/dceoy/create-pypkg/actions/workflows/python-publish.yml/badge.svg)](https://github.com/dceoy/create-pypkg/actions/workflows/python-publish.yml)
[![CI to Docker Hub](https://github.com/dceoy/create-pypkg/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/dceoy/create-pypkg/actions/workflows/docker-publish.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.


