Compare commits

..

No commits in common. "0cec8101b65be6e13fcd3ec49756bfde9c6693fe" and "7236a56548749e1d8f4619dd52a274a32950f69a" have entirely different histories.

4 changed files with 14 additions and 20 deletions

View file

@ -1,6 +1,6 @@
# puffb # puffpan
puffb is a small Python module for interacting with a Pufferpanel daemon. puffpan is a small Python module for interacting with a Pufferpanel daemon.
Made this in my spare time because I needed it. Made this in my spare time because I needed it.
@ -13,31 +13,27 @@ 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. 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 module available. Make sure you have the requests and json modules available.
### Usage ### Usage
```bash
pip install puffb
```
```python ```python
import puffb import puffpan
... ...
``` ```
Now you are ready to create a puffb! Now you are ready to create a puffpan!
Using the information you gathered before, create an object: Using the information you gathered before, create an object:
```python ```python
server = puffb.Panel('your-server-url', 'your-client-id', 'your-secret-key', 'your-server-id') server = puffpan.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: Or, alternatively, if you want to use a client that has access to multiple servers at once:
```python ```python
admin = puffb.Panel('your-server-url', 'your-client-id', 'your-secret-key') admin = puffpan.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 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] [metadata]
description_file = README.md description-file = README.md

View file

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