feat: initial work (#2)

.gitignore

@@ -6,6 +6,9 @@ __pycache__/
 # C extensions
 *.so
 
+# VS-code 
+.vscode
+
 # Distribution / packaging
 .Python
 build/

.readthedocs.yml

@@ -0,0 +1,14 @@
+# Required
+version: 2
+
+# Image to use
+build:
+  image: testing
+
+# Configuration
+python:
+  version: 3.10
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant homepage](http://contributor-covenant.org/version/1/4), version 1.4.

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+## Types of Contributions
+
+### Report Bugs
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+You can never have enough documentation! Please feel free to contribute to any
+part of the documentation, such as the official docs, docstrings, or even
+on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `masterblaster.py` for local development.
+
+1. Download a copy of `masterblaster.py` locally.
+2. Install `masterblaster.py` using `poetry`:
+
+    ```console
+    $ poetry install
+    ```
+
+3. Use `git` (or similar) to create a branch for local development and make your changes:
+
+    ```console
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
+
+5. Commit your changes and open a pull request.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include additional tests if appropriate.
+2. If the pull request adds functionality, the docs should be updated.
+3. The pull request should work for all currently supported operating systems and versions of Python.
+
+## Code of Conduct
+
+Please note that the `masterblaster.py` project is released with a
+Code of Conduct. By contributing to this project you agree to abide by its terms.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Nohr]
+
+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

@@ -1,2 +1,56 @@
-# MasterBlaster python
+# Masterblaster
 Python API wrapper for masterblaster.gg
+## Installation
+
+```bash
+$ pip install masterblaster.py
+```
+
+## Usage
+
+Masterblaster is a python API wrapper for the masterblaster.gg API. It allows you to easily access the data from the API and use it in your own projects.
+I.e.:
+
+```python
+import asyncio
+import dotenv
+import masterblaster
+
+
+async def main():
+    async with masterblaster.MasterBlaster(os.getenv("TOKEN"),"UiT") as m:
+        for member in await m.get_members():
+            print(member)
+
+    # Alternative
+    m = await masterblaster.MasterBlaster.create(os.getenv("TOKEN"),"UiT")
+    for member in await m.get_members():
+        print(member)
+    await m.teardown()
+
+    # Or Perhaps
+    m = masterblaster.MasterBlaster(os.getenv("TOKEN"),"UiT")
+    ...
+    ...
+    async with m:
+        for member in await m.get_members():
+            print(member)
+
+
+if __name__ == "__main__":
+    dotenv.load_dotenv()
+    asyncio.run(main())
+```
+
+## Contributing
+
+Interested in contributing? Check out the contributing guidelines. 
+Please note that this project is released with a Code of Conduct. 
+By contributing to this project, you agree to abide by its terms.
+
+## License
+
+`masterblaster` was created by Øyvind Nohr. It is licensed under the terms
+of the MIT license.
+
+## Credits

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = masterblaster.py
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conduct.md

@@ -0,0 +1,2 @@
+```{include} ../CONDUCT.md
+```

docs/conf.py

@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+
+project = "masterblaster.py"
+copyright = "2023, Øyvind Nohr"
+author = "Øyvind Nohr"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "myst_nb",
+    "autoapi.extension",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+autoapi_dirs = ["../masterblaster"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"

docs/contributing.md

@@ -0,0 +1,2 @@
+```{include} ../CONTRIBUTING.md
+```

docs/example.ipynb

@@ -0,0 +1,95 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Usage\n",
+    "To use `masterblaster` in a project:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "ModuleNotFoundError",
+     "evalue": "No module named 'masterblaster'",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m                       Traceback (most recent call last)",
+      "Cell \u001b[0;32mIn[4], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01mmasterblaster\u001b[39;00m\u001b[38;5;21;01m.\u001b[39;00m\u001b[38;5;21;01mpy\u001b[39;00m\n\u001b[1;32m      3\u001b[0m \u001b[38;5;28mprint\u001b[39m(masterblaster\u001b[38;5;241m.\u001b[39m__version__)\n",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m: No module named 'masterblaster'"
+     ]
+    }
+   ],
+   "source": [
+    "import masterblaster\n",
+    "\n",
+    "print(masterblaster.__version__)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import asyncio\n",
+    "from masterblaster import MasterBlaster\n",
+    "\n",
+    "def main():\n",
+    "    '''\n",
+    "    This is a simple example of how to use the MasterBlaster class getting all members in an organization.\n",
+    "    '''\n",
+    "    async def ex1():\n",
+    "        mb = await MasterBlaster.create(\"MY-TOKEN-HERE\", \"MY-ORGANIZATION-HERE\")\n",
+    "        for member in await mb.get_members():\n",
+    "            print(member)\n",
+    "        await mb.teardown()\n",
+    "\n",
+    "    async def ex2():\n",
+    "        async with MasterBlaster(\"MY-TOKEN-HERE\", \"MY-ORGANIZATION-HERE\") as mb:\n",
+    "            for member in await mb.get_members():\n",
+    "                print(member)\n",
+    "    \n",
+    "    async def ex3():\n",
+    "        mb = MasterBlaster(\"MY-TOKEN-HERE\", \"MY-ORGANIZATION-HERE\")\n",
+    "        #...\n",
+    "        #...\n",
+    "        async with mb:\n",
+    "            for member in await mb.get_members():\n",
+    "                print(member)\n",
+    "        #...\n",
+    "    \n",
+    "    asyncio.run(ex1())\n",
+    "    asyncio.run(ex2())\n",
+    "    asyncio.run(ex3())\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.13"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/index.md

@@ -0,0 +1,12 @@
+```{include} ../README.md
+```
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+example.ipynb
+contributing.md
+conduct.md
+autoapi/index
+```