Skip to main content

A Python Compression Software

Project description

PressPy

A Python compression software.

Intallation

Intall with Pip:

pip install --upgrade presspy

Install latest Github version: May have many bugs!

pip install --upgrade git+https://github.com/BD103/presspy

How to Use

PressPy is purely console based. Open up command prompt, or another console likewise, and type presspy. This gives you a list of available commands and options. There are three main functions:

Run

Runs a .press file.

Usage:

presspy run file --keep

File: The location of your .press file relative to your current directory.

--keep: Use this flag if you wish to keep the extracted source after running.

Press

Presses a Python program into a .press file.

Usage:

presspy press path

Path: The folder or directory your source code is in relative to your current directory. This folder must contain a press.json file. See the Wiki for more information.

Extract

Puts the source of a .press file into a folder.

Usage:

presspy extract file

File: The location of your .press file relative to your current directory.

Contributing

After editing the code, run it through our checks:

pip install -r requirements.txt
black presspy tests
flake8
pytest

Black should return something along the lines of:

All done! ✨ 🍰 ✨
1 file reformatted, 3 files left unchanged.

Flake8 should return any other formatting errors and a count, so you should see:

0

Last, Pytest should tell you:

==================== test session starts ====================
platform linux -- Python 3.8.7, pytest-6.2.1, py-1.10.0, pluggy-0.13.1
rootdir: /home/runner/PressPy
collected 2 items

tests/test_presspy.py ..                              [100%]

===================== 2 passed in 0.20s =====================

Once you don't have any errors, create a pull request. We will soon check it over! Thanks for contributing! Github also checks over PR to the Main branch with Github Actions, just to double check.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

presspy-1.0.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

presspy-1.0.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file presspy-1.0.0.tar.gz.

File metadata

  • Download URL: presspy-1.0.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.8.0 tqdm/4.54.1 CPython/3.8.7

File hashes

Hashes for presspy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 42a67f225967f795eef7236c78857fba6b2e3491aa6fc8906ab03a82f20aa9de
MD5 8938313a8aecca2d7ce1e6d0523369d5
BLAKE2b-256 d162fac7965033787122b53d47bf9510f005d1a0ac5369fe0c1a851c558f6417

See more details on using hashes here.

File details

Details for the file presspy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: presspy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.8.0 tqdm/4.54.1 CPython/3.8.7

File hashes

Hashes for presspy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee0d743a4ab1b45f3c8e2324ca6bfbe64e3dc193de2f95e5be9a1417d74544af
MD5 89a2c410a141b6b97a5597fb93270b3b
BLAKE2b-256 cb45c78e8e2c6366f8c7497fd06be98299f9a2c289c738cce6517ef168b64197

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page