Compare commits
10 commits
7236a56548
...
0cec8101b6
Author | SHA1 | Date | |
---|---|---|---|
0cec8101b6 | |||
7d29923890 | |||
9cf0911a5c | |||
11156f9823 | |||
13d0109334 | |||
1e0a5e5926 | |||
a056a325a9 | |||
041d6e00a5 | |||
cca8bd714e | |||
8b653c13f5 |
18
README.md
18
README.md
|
@ -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.
|
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.
|
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
|
### Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install puffb
|
||||||
|
```
|
||||||
|
|
||||||
```python
|
```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:
|
Using the information you gathered before, create an object:
|
||||||
|
|
||||||
```python
|
```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:
|
Or, alternatively, if you want to use a client that has access to multiple servers at once:
|
||||||
|
|
||||||
```python
|
```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
|
Keep in mind that with this method, you will have to specify the server ID for most commands. Instead of
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
[metadata]
|
[metadata]
|
||||||
description-file = README.md
|
description_file = README.md
|
||||||
|
|
14
setup.py
14
setup.py
|
@ -1,13 +1,15 @@
|
||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name = "puffpan",
|
name = "puffb",
|
||||||
description = "puffpan is a small python module for interacting with a Pufferpanel daemon.",
|
keywords = ["pufferpanel"],
|
||||||
|
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/puff",
|
url = "https://github.com/powermaker450/puffb",
|
||||||
install_requires = ["setuptools", "requests"],
|
download_url = "https://github.com/powermaker450/puffb/archive/refs/tags/v1.0.tar.gz",
|
||||||
py_modules = ["pufferpy"],
|
install_requires = ["requests"],
|
||||||
|
py_modules = ["puffb"],
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in a new issue