Skip to main content

CLI tool that helps manage shell libraries.

Project description

shmgr

CLI tool that helps manage shell libraries.

Badges 📛

project status badges:

CI Workflow Coverage Documentation Status Package Health

version badges:

Project Version Python Versions Cookiecutter: cc-python Docker: bbugyi/python

tools / frameworks used by test suite (i.e. used by make test):

Framework: pytest Framework: doctest Runner: tox Types: typeguard Mocks: pytest-mock Snapshots: syrupy

linters used to maintain code quality (i.e. used by make lint):

Linter: pylint Linter: flake8 Types: mypy Docstrings: pydocstyle Code Style: black Imports: isort

tools / frameworks used to render documentation (i.e used by make build-docs):

Rendered By: sphinx Hosted On: ReadTheDocs Types: sphinx-autodoc-typehints Markdown: m2r2

miscellaneous tools used to maintain this project:

Cookiecutter Updates: cruft Requirements: pip-tools Releases: bump2version Versioning: setuptools_scm

Installation 🗹

Using pipx to Install (preferred)

This package could be installed using pip like any other Python package (in fact, see the section below this one for instructions on how to do just that). Given that we only need this package's entry points, however, we recommend that pipx be used instead:

# install and setup pipx
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# install shmgr
pipx install shmgr

Using pip to Install

To install shmgr using pip, run the following commands in your terminal:

python3 -m pip install --user shmgr  # install shmgr

If you don't have pip installed, this Python installation guide can guide you through the process.

Useful Links 🔗

  • API Reference: A developer's reference of the API exposed by this project.
  • cc-python: The cookiecutter that was used to generate this project. Changes made to this cookiecutter are periodically synced with this project using cruft.
  • CHANGELOG.md: We use this file to document all notable changes made to this project.
  • CONTRIBUTING.md: This document contains guidelines for developers interested in contributing to this project.
  • Create a New Issue: Create a new GitHub issue for this project.
  • Documentation: This project's full documentation.

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

shmgr-0.1.0.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shmgr-0.1.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file shmgr-0.1.0.tar.gz.

File metadata

  • Download URL: shmgr-0.1.0.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for shmgr-0.1.0.tar.gz
Algorithm Hash digest
SHA256 30dbcf2db8b4577b37216967d50f857656accbf9d302eb2fe2b0f7acf518a6dd
MD5 01d61aa1f926d20eca7f7e1d95d0aab8
BLAKE2b-256 1b0f6029da5b93b2507d54a2b2dcbc4d5bce243716cc2e2fd3b3964a6865e5ff

See more details on using hashes here.

File details

Details for the file shmgr-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: shmgr-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for shmgr-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 81435c6527f8c73c7574897819adb0ea4777294a4a4aded8f50eb7ed43664368
MD5 8800586039dad63ed1b766838f9d5f47
BLAKE2b-256 50edd30e961970c8f1359bad2667ab9cc4e65aedb579cab833208362dc6b900e

See more details on using hashes here.

Supported by

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