Compare commits

...

10 commits

Author SHA1 Message Date
powermaker450 0cec8101b6
Update README.md 2024-05-31 20:35:44 -04:00
powermaker450 7d29923890
Update README.md 2024-05-31 14:06:23 -04:00
powermaker450 9cf0911a5c
Update setup.py 2024-05-31 14:05:56 -04:00
powermaker450 11156f9823
Rename puffpan.py to puffb.py 2024-05-31 14:05:14 -04:00
powermaker450 13d0109334
Update setup.py 2024-05-31 11:56:24 -04:00
powermaker450 1e0a5e5926
Update setup.py 2024-05-31 11:46:41 -04:00
powermaker450 a056a325a9
Update setup.py 2024-05-31 11:46:11 -04:00
powermaker450 041d6e00a5
Update setup.cfg 2024-05-31 11:45:30 -04:00
powermaker450 cca8bd714e
Update setup.py 2024-05-31 11:44:22 -04:00
powermaker450 8b653c13f5
Update setup.py 2024-05-31 11:43:16 -04:00
4 changed files with 20 additions and 14 deletions

View file

@ -1,6 +1,6 @@
# puffpan
# puffb
puffpan is a small Python module for interacting with a Pufferpanel daemon.
puffb is a small Python module for interacting with a Pufferpanel daemon.
Made this in my spare time because I needed it.
@ -13,27 +13,31 @@ Create an OAuth2 application for this server. Like it says, **write down the sec
Now you have Pufferpanel, a server, it's server ID (randomly generated 8 character string, usually displayed in the URL in the browser), client ID and secret ID.
Make sure you have the requests and json modules available.
Make sure you have the requests module available.
### Usage
```bash
pip install puffb
```
```python
import puffpan
import puffb
...
```
Now you are ready to create a puffpan!
Now you are ready to create a puffb!
Using the information you gathered before, create an object:
```python
server = puffpan.Panel('your-server-url', 'your-client-id', 'your-secret-key', 'your-server-id')
server = puffb.Panel('your-server-url', 'your-client-id', 'your-secret-key', 'your-server-id')
```
Or, alternatively, if you want to use a client that has access to multiple servers at once:
```python
admin = puffpan.Panel('your-server-url', 'your-client-id', 'your-secret-key')
admin = puffb.Panel('your-server-url', 'your-client-id', 'your-secret-key')
```
Keep in mind that with this method, you will have to specify the server ID for most commands. Instead of

View file

@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description_file = README.md

View file

@ -1,13 +1,15 @@
from setuptools import setup
setup(
name = "puffpan",
description = "puffpan is a small python module for interacting with a Pufferpanel daemon.",
name = "puffb",
keywords = ["pufferpanel"],
description = "puffb is a small python module for interacting with a Pufferpanel daemon.",
version = "1.0",
author = "powermaker450",
author_email = "contact@povario.com",
url = "https://github.com/powermaker450/puff",
install_requires = ["setuptools", "requests"],
py_modules = ["pufferpy"],
url = "https://github.com/powermaker450/puffb",
download_url = "https://github.com/powermaker450/puffb/archive/refs/tags/v1.0.tar.gz",
install_requires = ["requests"],
py_modules = ["puffb"],
license = "MIT"
)
)