Skip to main content

Run scripts easily...

Project description

Welcome to PSM

What is PSM?

PSM (Python Script Manager) is a script manager for Python programming language. You can manage your scripts with this tool. You can create scripts, use them, delete them and etc. PSM gives you chance to call longer commands with shorter commands. I inspired by npm scripts to make Python version of it. Check out New features or Contribution documentation

Installation

For install PSM you will need pip. I you have not click here After installing pip, enter command below.

pip3 install python-script-manager

To make sure you have successfully installed it,

psm

Usage

First you need to initialize PSM in your directory.

psm init

You can also start with template.

Some of available templates:

  • blank
  • django

Example,

psm init -t django
# or
psm init --template="django"

It will create psm.json which keeps your script informations.

Create Script

To create script, use add command.

psm add

It will ask you name, command and description (optional) for your script. You can also pass them as options

psm add --name="Name of script" --command="Command" --description="Description for script (optional)"

List scripts

To get list of scripts, enter command below:

psm list

Run scripts

To run scripts use syntax below:

psm run [SCRIPT_NAME]

Remove script

If you want to remove unused scripts, enter command below:

psm rm -n [SCRIPT_NAME]

Special scripts

If you name a script which is in list below, you can use special script feature.

List of special scripts:

  • start
  • deploy
  • build

To run special scripts, use syntaxt below:

psm SPECIAL_SCRIPT

Example,

psm build

PIP shortcuts

To install dependencies in requirements.txt, use

psm install

Or you can output dependencies to requirements.txt

psm freeze

Project settings

Setting version

Optionally, you can define version for your project. If you are building python package, it is useful for versioning. To set new version:

psm setv
# or
psm set-version

It will not change, if you do not enter any value to input. To use version in setup.py for your packages, you can use PSMReader object.

from python_script_manager.package import PSMReader

psm = PSMReader('directory of psm.json')
# in most cases, "psm.json" will work as directory

setuptools.setup(
    # ...
    version=psm.get_version(),
    # ...

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

python-script-manager-1.1.5.tar.gz (9.1 kB view hashes)

Uploaded Source

Built Distribution

python_script_manager-1.1.5-py3-none-any.whl (13.0 kB view hashes)

Uploaded Python 3

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