Metadata-Version: 2.1
Name: indentify
Version: 0.0.1
Summary: Format any code-like snippet in an indented style.
Home-page: https://github.com/tusharsadhwani/indentify
Author: Tushar Sadhwani
Author-email: tushar.sadhwani000@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# python-starter

A straightforward starter template for Python packages.

Includes things like:

- All necessary files and paths in `.gitignore`
- `setup.cfg` configuration
- Local development using `requirements.txt` and `requirements-dev.txt`
- Tools like `mypy`, `black` and `pytest` set up out of the box

## Setup

- Clone this repo and delete `.git`
- Rename `src/sample_package` folder to your package name
- Rename the package import in `tests/sample_test.py`
- Edit the marked fields in `setup.cfg`, and remove comments
- Edit `LICENSE`
- Setup and activate a [virtualenv](https://docs.python.org/3/tutorial/venv.html)
- Run `pip install -r requirements-dev.txt`
- That's it! See if it worked by running `mycommand` and `python -m <package name>`

## Testing

Run `pytest`

## Type Checking

Run `mypy .`

## Create and upload a package to PyPI

Make sure to bump the version in `setup.cfg`.

Then run the following commands:

```bash
rm -rf build dist
python setup.py sdist bdist_wheel
```

Then upload it to PyPI using [twine](https://twine.readthedocs.io/en/latest/#installation):

```bash
twine upload dist/*
```


