https://github.com/mauricelambert/webscriptstools
This package implements tools for WebScripts Scripts.
https://github.com/mauricelambert/webscriptstools
cli pypi-package python3 tools webscripts
Last synced: about 2 months ago
JSON representation
This package implements tools for WebScripts Scripts.
- Host: GitHub
- URL: https://github.com/mauricelambert/webscriptstools
- Owner: mauricelambert
- License: gpl-3.0
- Created: 2022-01-08T21:55:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-27T20:24:02.000Z (over 1 year ago)
- Last Synced: 2025-03-25T07:41:36.871Z (3 months ago)
- Topics: cli, pypi-package, python3, tools, webscripts
- Language: Python
- Homepage: https://webscripts.readthedocs.io/
- Size: 32.2 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# WebScriptsTools
## Description
This package implements tools for WebScripts Scripts.
## Requirements
This package require:
- python3
- python3 Standard Library
## Installation
```bash
pip install WebScriptsTools
```
## Usages
### Command line
#### Module
```bash
# These command lines should be launch in a WebScripts Scripts Environment !
python3 -m WebScriptsTools
python3 -m WebScriptsTools get_log_file
python3 -m WebScriptsTools get_upload_script
python3 -m WebScriptsTools get_webscripts_data_path
```
If you run these command lines outside the WebScripts scripting environment, you get this error:
```text
TypeError: the JSON object must be str, bytes or bytearray, not NoneType
```
Example of usage in a script bash:
```bash
logfile=$(python3 -m WebScriptsTools get_log_file)
echo "DEBUG: Get log file from WebScriptsTools" > "${logfile}"
cat "$(python3 -m WebScriptsTools get_webscripts_data_path)/datafile.txt"
echo "INFO: print data using WebScripts data directory" > "${logfile}"
cat myfile.txt | "$(python3 -m WebScriptsTools get_upload_script)" uploaded_filename.txt
cat myfile.txt | "$(python3 -m WebScriptsTools get_upload_script)" -r 1000 -w 1000 -d 1000 -H -b -c -i uploaded_filename.txt
```
### Python script
```python
# To use this module you should be in a WebScripts Scripts Environment
from WebScriptsTools import *
set_excepthook() # manage exceptions without printing sensible informations
# Get the upload module, to read, delete or write a shared file
upload = get_upload_module()
upload.get_file("my_webscripts_shared_file.txt")
# Use the data path to change databases
with open(f"{get_webscripts_data_path()}/datafile.txt") as datafile:
print(datafile.read())
# Get the log file to configure your logger or read your logs
logs = open(get_log_file())
log = logs.readline()
while log:
print(log)
log = logs.readline()
# Get the user to check permission or get informations like ID or name
user = get_user()
print(f"You are named '{user['name']}' here !")
class ClassModule:
@module2to3
def method(
self,
environ,
user,
configuration,
filename,
commande,
inputs,
csrf_token: str = None,
) -> Tuple[str, Dict[str, str], bytes]:
return "200 OK", {}, b'data'
@module2to3
def function(
environ,
user,
configuration,
filename,
commande,
inputs,
csrf_token: str = None,
) -> Tuple[str, Dict[str, str], bytes]:
return "200 OK", {}, b'data'
```
## Links
- [Github Page](https://github.com/mauricelambert/WebScriptsTools/)
- [Documentation](https://mauricelambert.github.io/info/python/code/WebScriptsTools.html)
- [Pypi package](https://pypi.org/project/WebScriptsTools/)
## Licence
Licensed under the [GPL, version 3](https://www.gnu.org/licenses/).