Skip to main content

PythonAnywhere helper tools for users

Project description

Build Status License: MIT PyPI Downloads

PythonAnywhere cli tool

pa is a single command to manage PythonAnywhere services.

It is designed to be run from PythonAnywhere consoles, but many subcommands can be executed directly from your own machine (see usage below).

Installing

On PythonAnywhere

In a PythonAnywhere Bash console, run:

pip3.10 install --user pythonanywhere

If there is no python3.10 on your PythonAnywhere account, you should upgrade your account to the newest system image. See here how to do that. pa works with python 3.8, 3.9, and 3.10 but we recommend using the latest system image.

On your own machine

Install the pythonanywhere package from PyPI. We recommend using pipx if you want to use it only as a cli tool, or a virtual environment if you want to use a programmatic interface in your own code.

Usage

There are two ways to use the package. You can just run the scripts or use the underlying api wrappers directly in your scripts.

Command line interface

Running pa on your local machine

pa expects the presence of some environment variables that are provided when you run your code in a PythonAnywere console. You need to provide them if you run pa on your local machine.

API_TOKEN -- you need to set this to allow pa to connect to the PythonAnywere API. To get an API token, log into PythonAnywhere and go to the "Account" page using the link at the top right. Click on the "API token" tab, and click the "Create a new API token" button to get your token.

PYTHONANYWHERE_SITE is used to connect to PythonAnywhere API and defaults to www.pythonanywhere.com, but you may need to set it to eu.pythonanywhere.com if you use our EU site.

If your username on PythonAnywhere is different from the username on your local machine, you may need to set USER for the environment you run pa in.

Programmatic usage in your code

Take a look at the pythonanywhere.task module and docstrings of pythonanywhere.task.Task class and its methods.

Legacy scripts

Some legacy scripts (separate for each action) are still available.

Contributing

Pull requests are welcome! You'll find tests in the tests folder...

# prep your dev environment
mkvirtualenv --python=python3.10 helper_scripts
pip install -r requirements.txt
pip install -e .

# running the tests:
pytest

# make sure that the code that you have written is well tested:
pytest --cov=pythonanywhere --cov=scripts

# to just run the fast tests:
pytest -m 'not slowtest' -v

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

pythonanywhere-0.15.5.tar.gz (53.2 kB view details)

Uploaded Source

Built Distribution

pythonanywhere-0.15.5-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

Details for the file pythonanywhere-0.15.5.tar.gz.

File metadata

  • Download URL: pythonanywhere-0.15.5.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pythonanywhere-0.15.5.tar.gz
Algorithm Hash digest
SHA256 6abab25d405111a2a0ab94f05d06dc0e2958bc53af082224dd3012f86b1840d9
MD5 5989ef4eb26317fe1b07e5807cad8630
BLAKE2b-256 000b9d0d6bf6d2bfde59c5d4335e925964c6322f2f81c01905fd4daa82202a44

See more details on using hashes here.

File details

Details for the file pythonanywhere-0.15.5-py3-none-any.whl.

File metadata

File hashes

Hashes for pythonanywhere-0.15.5-py3-none-any.whl
Algorithm Hash digest
SHA256 aae0931150b9df7bbcf7d38555351f5f78d024a75f83e8d9a07a9fafc66fca7e
MD5 7c78d39786d332364a1b0c3e49c74fff
BLAKE2b-256 b50746ca5a3bbefec9a1008015a557f836d01b043508e2c93df550fcb773edd1

See more details on using hashes here.

Supported by

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