https://github.com/lancelote/archive-project

CLI tool to zip Python project and copy archive to the desktop
https://github.com/lancelote/archive-project

archive python

Last synced: about 2 months ago
JSON representation

CLI tool to zip Python project and copy archive to the desktop

• Host: GitHub
• URL: https://github.com/lancelote/archive-project
• Owner: lancelote
• License: mit
• Created: 2021-06-12T20:05:44.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-14T19:29:14.000Z (almost 4 years ago)
• Last Synced: 2025-03-29T00:12:48.676Z (2 months ago)
• Topics: archive, python
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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