Skip to content

Commit 9d0e4f5

Browse files
usage information in readme
1 parent 95c2f3f commit 9d0e4f5

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,35 @@ These scripts are designed to be run from PythonAnywhere consoles
1414
If there is no `python3.6` on your PythonAnywhere account,
1515
you should contact [[email protected]](mailto:[email protected]) and ask for an upgrade.
1616

17+
## Usage
18+
19+
There are two ways to use that package. You can just run the scripts or use underlying api wrappers directly in your scripts.
20+
21+
There are scripts provided for dealing with web apps:
22+
23+
* [pa_autoconfigure_django.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_autoconfigure_django.py)
24+
* [pa_create_webapp_with_virtualenv.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_create_webapp_with_virtualenv.py)
25+
* [pa_delete_webapp_logs.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_delete_webapp_logs.py)
26+
* [pa_install_webapp_letsencrypt_ssl.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_install_webapp_letsencrypt_ssl.py)
27+
* [pa_install_webapp_ssl.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_install_webapp_ssl.py)
28+
* [pa_reload_webapp.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_reload_webapp.py)
29+
* [pa_start_django_webapp_with_virtualenv.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_start_django_webapp_with_virtualenv.py)
30+
31+
and scheduled tasks:
32+
33+
* [pa_create_scheduled_task.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_create_scheduled_task.py)
34+
* [pa_delete_scheduled_task.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_delete_scheduled_task.py)
35+
* [pa_get_scheduled_tasks_list.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_get_scheduled_tasks_list.py)
36+
* [pa_get_scheduled_task_specs.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_get_scheduled_task_specs.py)
37+
* [pa_update_scheduled_task.py](https://github.com/pythonanywhere/helper_scripts/blob/master/scripts/pa_update_scheduled_task.py)
38+
39+
Run any of them with `--help` flag to get information about usage.
40+
41+
See the [blog post](https://blog.pythonanywhere.com/155/)
42+
1743
## Contributing
1844

19-
Pull requests are welcome! You'll find tests in the [tests](tests) folder...
45+
Pull requests are welcome! You'll find tests in the [tests](https://github.com/pythonanywhere/helper_scripts/blob/master/tests) folder...
2046

2147
# prep your dev environment
2248
mkvirtualenv --python=python3.6 helper_scripts
@@ -31,3 +57,4 @@ Pull requests are welcome! You'll find tests in the [tests](tests) folder...
3157

3258
# to just run the fast tests:
3359
pytest -m 'not slowtest' -v
60+

0 commit comments

Comments
 (0)