Metadata-Version: 2.1
Name: create-python-package
Version: 0.1.0.0
Summary: Create the file and folder structure for a Python package
Home-page: https://github.com/cs01/create-python-package
Author: Chad Smith
Author-email: grassfedcode@gmail.com
License: License :: OSI Approved :: MIT License
Keywords: package,setup
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown

<a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>

# create-python-package
Initialize a new package using best practices as described by the [Python Packaging Authority (PyPA)](https://packaging.python.org/tutorials/packaging-projects/). Perfect for beginners and experts alike. No more guesswork!

Read more on the [blog post](https://medium.com/@grassfedcode/bringing-some-of-javascripts-packaging-solutions-to-python-1b02430d589e).

## Overview
This package ships with four CLI entrypoints:
```
- build-python-package
- create-python-package
- create-venv
- publish-python-package
```

To use create-python-package:
```
create-python-package mypackage
cd mypackage
source activate
```

To publish (which automatically builds first), run
```
publish-python-package path_to_package
```

To build without publishing
```
build-python-package path_to_package
````

To create a virtual environment
```
create-venv path  # creates venv at path/venv and symlink to activate at path/activate
# then run `source activate` to activate the virtual environment
````


## Virtualenv ready to go!
Inside the directory you can run
```
source activate
```
to activate an isolated Python environment that was created specifically for that package. To deactivate it, type
```
deactivate
```

To learn more about virtual environments, see [Creating Virtual Environments](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments).

## Installation
*[pipx](https://github.com/pipxproject/pipx) allows you to run or install Python binaries from packages*
```
python3 -m pip install --user pipx
pipx ensurepath
```

You can run the latest version directly with
```
pipx run create-python-package
```

or install with

```
pipx install create-python-package
```


>pipx install create-python-package
  installed package create-python-package, 0.0.0.5
  These binaries are now globally available
    - build-python-package
    - create-python-package
    - create-venv
    - publish-python-package
done! ✨ 🌟 ✨

If you do not wish to use pipx, you can install as follows.
```
python3 -m venv venv  # create a virtual environment
source venv/bin/activate  # activate the virtual environment
pip install -U pip  # upgrade pip
pip install create-python-package
```


Requires Python 3.6+.

## Example Session
```
> create-python-package /tmp/fake
Creating a new Python package in /private/tmp/fake

Creating a virtual environment at /private/tmp/fake/venv
Upgrading pip in the virtual environment.

Initialized a git repository.

Success! Created fake at /private/tmp/fake
Inside that directory, you can run several commands

  source activate
     Activates this package's isolated Python environment

  pip install PACKAGE
    Installs a package to current environment

  pip install -e .
    Installs this package in editable mode to the current environment

We suggest that you being by typing:

  cd fake
  source activate

To deactivate the virtual environment, type `deactivate`.

Questions? Create an issue at https://github.com/cs01/create-python-package

Happy hacking!
```

## Credits
Created and published using `create-python-package` 😄

Inspired by [create-react-app](https://github.com/facebook/create-react-app)


