pieforhead 0.0.1__tar.gz

pieforhead-0.0.1/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+.vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pieforhead-0.0.1/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

pieforhead-0.0.1/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.5
+Name: pieforhead
+Version: 0.0.1
+Summary: A python library for interacting with the PieFed API
+Project-URL: Homepage, https://github.com/wjs018/pieforhead
+Project-URL: Issues, https://github.com/wjs018/pieforhead/issues
+Author-email: wjs018 <wjs018@gmail.com>
+License-Expression: Unlicense
+License-File: LICENSE
+Keywords: fediverse,piefed
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: httpx
+Requires-Dist: semver
+Description-Content-Type: text/markdown
+
+# pieforhead
+
+A python wrapper for the PieFed API supporting both synchronous and asynchronous usage. This is an early work in progress, and few endpoints are supported yet.
+
+![pieforhead logo](logo.png)
+
+## Usage Notes
+
+In general, all successful requests to the server should return a `dict` with the server's json response. Due to the alpha nature of the PieFed API, the maintenance burden of creating and updating response models as features/fields are added to the API is a burden that I don't want to take on at this time. Please refer to the official PieFed OpenAPI specification ([stable version](https://stable.wjs018.xyz/api/alpha/swagger), [development version](https://crust.piefed.social/api/alpha/swagger)) to see what your code should expect as a response.
+
+By default, exceptions will be raised if something goes wrong (e.g. malformed request, network timeout, 5XX errors, etc.) to provide a trace. However, to suppress these exceptions, you can pass the `raise_exceptions=False` keyword argument when instantiating your client. This will cause a returned value of `None` instead of raising an exception. Please make sure that your code handles such a case appropriately.
+
+## Synchronous Client Usage
+
+Users familiar with network libraries like `requests` would probably be most familiar with synchronous usage. However, to make network requests a bit more efficient, this library makes use of `Client`s within `httpx` where you can take advantage of connection pooling for multiple network requests. This means that when you instantiate a `PieFed` class, it is best practice to close it when you are done with it. Here are a couple examples that show how this can be done.
+
+These snippets all do the same three things:
+
+1. Create a `PieFed` object with the given instance url (this creates the client)
+2. Log in using a username and password
+3. Close the client after we no longer need it
+
+Closing it manually using the `close` function:
+
+```python
+from piefedhead import PieFed
+
+piefed = PieFed("https://instance.tld")
+piefed.log_in("username", "password")
+
+piefed.close()
+```
+
+Using a context manager (a `with` block):
+
+```python
+# Inside a context manager
+with PieFed("https://instance.tld") as piefed:
+    piefed.log_in("username", "password")
+
+# The connection is closed after leaving the `with` block
+```
+
+Using a callback that ensures the `close` function is called when execution has ended:
+
+```python
+# Registering an event handler
+import atexit
+
+piefed = PieFed("https://instance.tld")
+atexit.register(piefed.close)  # Automatically closes the client at program termination
+```
+
+## Asynchronous Client Usage
+
+To use this libray in an async manner, there is a separate client, `PieFedAsync` that should be used. Everything else should work exactly the same as the synchronous client, except that results will need to be `await`ed.
+
+Here is a snippet that does the same three actions as outlined above for the synchronous client, but using the `PieFedAsync` client.
+
+```python
+# Put things in an async function so that we can use the await keyword
+async def main():
+    piefed_async = PieFedAsync("https://instance.tld")
+    await piefed_async.log_in("username", "password")  # Notice the await keyword
+
+    await piefed_async.close()
+
+# Start the event loop and execute the async function
+asyncio.run(main())
+```
+
+Similar to the synchronous client, you can also use a context handler to automatically close the async client:
+
+```python
+async def main():
+    async with PieFedAsync("https://instance.tld") as piefed_async:
+        await piefed_async.log_in("username", "password")
+
+    # Client is closed automatically once outside the context handler
+
+# Start the event loop and execute the async function
+asyncio.run(main())
+```
+
+## Endpoint Coverage
+
+This project is in an early stage. Here is a high level summary of where things stand with implementing the wrapper around different PieFed API endpoint groups:
+
+| Endpoint Group  | Sync Client | Async Client | Notes                                    |
+| :-------------: | :---------: | :----------: | :--------------------------------------- |
+|      Site       |     ✅      |      ✅      | Instance chooser endpoints unimplemented |
+|     Upload      |     ✅      |      ✅      |                                          |
+|      User       |     🟡      |      🟡      | Auth endpoints implemented               |
+|      Post       |     ❌      |      ❌      |                                          |
+|     Comment     |     ❌      |      ❌      |                                          |
+|    Community    |     ❌      |      ❌      |                                          |
+|      Feed       |     ❌      |      ❌      |                                          |
+|      Topic      |     ❌      |      ❌      |                                          |
+| Private Message |     ❌      |      ❌      |                                          |
+|      Admin      |     ❌      |      ❌      |                                          |
+|      Misc.      |     ❌      |      ❌      |                                          |

pieforhead-0.0.1/README.md

@@ -0,0 +1,101 @@
+# pieforhead
+
+A python wrapper for the PieFed API supporting both synchronous and asynchronous usage. This is an early work in progress, and few endpoints are supported yet.
+
+![pieforhead logo](logo.png)
+
+## Usage Notes
+
+In general, all successful requests to the server should return a `dict` with the server's json response. Due to the alpha nature of the PieFed API, the maintenance burden of creating and updating response models as features/fields are added to the API is a burden that I don't want to take on at this time. Please refer to the official PieFed OpenAPI specification ([stable version](https://stable.wjs018.xyz/api/alpha/swagger), [development version](https://crust.piefed.social/api/alpha/swagger)) to see what your code should expect as a response.
+
+By default, exceptions will be raised if something goes wrong (e.g. malformed request, network timeout, 5XX errors, etc.) to provide a trace. However, to suppress these exceptions, you can pass the `raise_exceptions=False` keyword argument when instantiating your client. This will cause a returned value of `None` instead of raising an exception. Please make sure that your code handles such a case appropriately.
+
+## Synchronous Client Usage
+
+Users familiar with network libraries like `requests` would probably be most familiar with synchronous usage. However, to make network requests a bit more efficient, this library makes use of `Client`s within `httpx` where you can take advantage of connection pooling for multiple network requests. This means that when you instantiate a `PieFed` class, it is best practice to close it when you are done with it. Here are a couple examples that show how this can be done.
+
+These snippets all do the same three things:
+
+1. Create a `PieFed` object with the given instance url (this creates the client)
+2. Log in using a username and password
+3. Close the client after we no longer need it
+
+Closing it manually using the `close` function:
+
+```python
+from piefedhead import PieFed
+
+piefed = PieFed("https://instance.tld")
+piefed.log_in("username", "password")
+
+piefed.close()
+```
+
+Using a context manager (a `with` block):
+
+```python
+# Inside a context manager
+with PieFed("https://instance.tld") as piefed:
+    piefed.log_in("username", "password")
+
+# The connection is closed after leaving the `with` block
+```
+
+Using a callback that ensures the `close` function is called when execution has ended:
+
+```python
+# Registering an event handler
+import atexit
+
+piefed = PieFed("https://instance.tld")
+atexit.register(piefed.close)  # Automatically closes the client at program termination
+```
+
+## Asynchronous Client Usage
+
+To use this libray in an async manner, there is a separate client, `PieFedAsync` that should be used. Everything else should work exactly the same as the synchronous client, except that results will need to be `await`ed.
+
+Here is a snippet that does the same three actions as outlined above for the synchronous client, but using the `PieFedAsync` client.
+
+```python
+# Put things in an async function so that we can use the await keyword
+async def main():
+    piefed_async = PieFedAsync("https://instance.tld")
+    await piefed_async.log_in("username", "password")  # Notice the await keyword
+
+    await piefed_async.close()
+
+# Start the event loop and execute the async function
+asyncio.run(main())
+```
+
+Similar to the synchronous client, you can also use a context handler to automatically close the async client:
+
+```python
+async def main():
+    async with PieFedAsync("https://instance.tld") as piefed_async:
+        await piefed_async.log_in("username", "password")
+
+    # Client is closed automatically once outside the context handler
+
+# Start the event loop and execute the async function
+asyncio.run(main())
+```
+
+## Endpoint Coverage
+
+This project is in an early stage. Here is a high level summary of where things stand with implementing the wrapper around different PieFed API endpoint groups:
+
+| Endpoint Group  | Sync Client | Async Client | Notes                                    |
+| :-------------: | :---------: | :----------: | :--------------------------------------- |
+|      Site       |     ✅      |      ✅      | Instance chooser endpoints unimplemented |
+|     Upload      |     ✅      |      ✅      |                                          |
+|      User       |     🟡      |      🟡      | Auth endpoints implemented               |
+|      Post       |     ❌      |      ❌      |                                          |
+|     Comment     |     ❌      |      ❌      |                                          |
+|    Community    |     ❌      |      ❌      |                                          |
+|      Feed       |     ❌      |      ❌      |                                          |
+|      Topic      |     ❌      |      ❌      |                                          |
+| Private Message |     ❌      |      ❌      |                                          |
+|      Admin      |     ❌      |      ❌      |                                          |
+|      Misc.      |     ❌      |      ❌      |                                          |

pieforhead-0.0.1/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

pieforhead-0.0.1/mkdocs.yml

@@ -0,0 +1 @@
+site_name: My Docs

pieforhead-0.0.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pieforhead"
+dynamic = ["version"]
+authors = [
+    {name = "wjs018", email = "wjs018@gmail.com"},
+]
+description = "A python library for interacting with the PieFed API"
+readme = "README.md"
+requires-python = ">=3.10"
+keywords = ["piefed", "fediverse"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 2 - Pre-Alpha",
+]
+license = "Unlicense"
+license-files = ["LICENSE"]
+dependencies =[
+  "httpx",
+  "semver",
+]
+
+[tool.hatch.version]
+path = "src/pieforhead/utils.py"
+
+[tool.hatch.build]
+exclude = ["/test_*"]
+
+[tool.hatch.build.targets.wheel]
+exclude = ["tests/**", "docs/**", "mkdocs.yml"]
+
+[project.urls]
+Homepage = "https://github.com/wjs018/pieforhead"
+Issues = "https://github.com/wjs018/pieforhead/issues"
+
+[tool.ruff]
+line-length = 119
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

pieforhead-0.0.1/src/pieforhead/__init__.py

@@ -0,0 +1,4 @@
+from .pieforhead import PieFed, PieFedAsync
+from .utils import __version__ as VERSION
+
+__all__ = ["PieFed", "PieFedAsync", "VERSION"]