Metadata-Version: 2.1
Name: archive-project
Version: 1.0.0
Summary: The CLI tool to zip Python project and copy archive to desktop
Home-page: https://github.com/lancelote/archive-project
Author: Pavel Karateev
Author-email: lancelote.du.lac@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: click
Requires-Dist: importlib-metadata ; python_version < "3.8"

# archive-project

CLI tool to archive a Python project under the current working directory
ignoring things like `.idea/`, `.mypy_cache`, `.venv`, etc. and send the
result `zip` to the desktop

## Installation

`pip install -U --user archive-project`

> The package will be installed in your user home directory. See `pip`
> documentation about [user installs][1]. You need the installation directory
> to be present in `PATH` to run `archive-project` from the terminal.

## Usage

```console
$ archive-project --help
Usage: archive-project [OPTIONS]

  Zip current Python project

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

$ archive-project
/Users/user/Desktop/archive-project.zip was successfully created
```

## Requirements

- Python 3.8+
- macOS

[1]: https://pip.pypa.io/en/latest/user_guide/#user-installs


