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.4.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

pythonanywhere-0.15.4-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pythonanywhere-0.15.4.tar.gz
Algorithm Hash digest
SHA256 23ca7eaf9c5b5457d0484bed857763a69868f8c368b44bfd90c6fa7f5727eeb9
MD5 ba391195008566c49d0ec4f3860e2dd5
BLAKE2b-256 0326057d7ca1890c9f9f4da6e81473a2f040f67693055c35151a7ec0c3f2334c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pythonanywhere-0.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b6547bc57beda8262b1f70744ded675482733fbabf81c043c32954df9d5f0377
MD5 ae43c067e8503e76a5762a9524de3289
BLAKE2b-256 2e6dfba1b6c033d9e03cb631a3db2b008f9f35cb5596d28d4f3e2fd7bcb1cdbd

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