Initial commit

.coveragerc

@@ -0,0 +1,9 @@
+# .coveragerc to control coverage.py
+[run]
+omit = 
+    # omit inits
+    __init__.py
+    # omit tests itself
+    tests/*
+    # omit abstract endpoints
+    */abstracts/*

.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

.github/workflows/publish_pypi.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry        
+      - name: Build and publish
+        run: |
+          poetry version $(git describe --tags --abbrev=0)
+          poetry config pypi-token.pypi ${{ secrets.PYPI_API_KEY }}
+          poetry publish --build 

.github/workflows/publish_testpypi.yml

@@ -0,0 +1,25 @@
+name: Publish to Test PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  testpypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry        
+      - name: Build and publish
+        run: |
+          poetry version $(git describe --tags --abbrev=0)
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_API_KEY }}
+          poetry publish --build -r testpypi

.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  - push
+  - pull_request
+
+
+jobs:
+  test:
+    runs-on: ${{matrix.os}}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python {{$matrix.python-version}}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{matrix.python-version}}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Run tests
+      run: python -m pytest -v
+    - name: Run test coverage
+      run: python -m pytest --cov

.gitignore

@@ -0,0 +1,184 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+
+# Created by https://www.gitignore.io/api/python,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# PyCharm
+.idea/
+
+# VSCode
+.vscode
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+/build/
+develop-eggs/
+/dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+coverage/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# PyCharm project settings
+.idea
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Temporarily generating these with pytype locally for type safety
+typeshed/
+pytype.cfg
+
+### Python Patch ###
+.venv/
+
+
+# End of https://www.gitignore.io/api/python,macos
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+.vs/slnx.sqlite
+
+# mypy/typing section
+typeshed/
+.dmypy.json
+mypyhtml/
+XDG_CACHE_HOME/
+snap/
+prime/
+stage/
+pip-wheel-metadata/
+.vim/
+
+# Newrelic
+newrelic.ini
+
+# Certificates
+*.pem
+*.key
+*.crt
+*.cer
+*.der
+*.priv
+
+letsencrypt/*

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 to present Jan Placht and individual contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

README.md

@@ -0,0 +1,61 @@
+# pyfio
+
+[FIO](https://doc.fnar.net/) API wrapper with [pydantic](https://github.com/pydantic/pydantic) data validation and easy-to-use querying. **fio_wrapper** implements the most used endpoints of Prosperous Universes community game data API.
+
+# Install
+```python
+pip install fio-wrapper
+```
+
+# Usage
+Creating the FIO adapter and looking for information about the material Drinking Water by its ticker "DW".
+```python
+from fio_wrapper import FIO
+
+fio = FIO()
+
+material = fio.Material.get("DW")
+print(material)
+print(material.model_dump_json())
+```
+
+This will print the material information of Drinking Water as MaterialModel and it's JSON.
+```python
+MaterialId='4fca6f5b5e6c3b8a1b887c6dc99db146' CategoryName='consumables (basic)' CategoryId='3f047ec3043bdd795fd7272d6be98799' Name='drinkingWater' Ticker='DW' Weight=0.10000000149011612 Volume=0.10000000149011612 UserNameSubmitted='SAGANAKI' Timestamp=datetime.datetime(2023, 10, 28, 19, 26, 21, 831707)
+```
+
+```json
+{
+    "MaterialId": "4fca6f5b5e6c3b8a1b887c6dc99db146",
+    "CategoryName": "consumables (basic)",
+    "CategoryId": "3f047ec3043bdd795fd7272d6be98799",
+    "Name": "drinkingWater",
+    "Ticker": "DW",
+    "Weight": 0.10000000149011612,
+    "Volume": 0.10000000149011612,
+    "UserNameSubmitted": "SAGANAKI",
+    "Timestamp": "2023-10-28T19:26:21.831707"
+}
+```
+
+# Contributing
+
+We welcome contributions of all types! In order to set up **fio_wrapper** locally please do the following:
+
+1. Install Python + Poetry
+2. Run the poetry environment and install depenencies
+3. We are aiming for 100% code coverage
+
+# Tests
+
+**fio_wrapper** uses `pytest`, `requests_mock` and `pytest-cov` to run tests, mock calls towards FIO endpoints and generate the code coverage report and use `black` as formatter.
+
+Run tests:
+```shell
+pytest 
+```
+
+Generate coverage report:
+```shell
+pytest --cov --cov-report=html:coverage --cov-config=.coveragerc
+```

example.py

@@ -0,0 +1,15 @@
+from pyfio import FIO
+
+fio = FIO()
+
+# material = fio.Material.get("DW")
+# print(material)
+# print(material.model_dump_json())
+
+
+# print(fio.LocalMarket.planet_buy("Promitor"))
+# print(fio.LocalMarket.planet_sell("Promitor"))
+# print(fio.LocalMarket.planet_shipping("ANT"))
+
+
+print(fio.LocalMarket.company("SKYP"))