gridworks-base 0.0.1__tar.gz

gridworks_base-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2022 GridWorks
+
+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.

gridworks_base-0.0.1/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.1
+Name: gridworks-base
+Version: 0.0.1
+Summary: Gridworks Base
+Home-page: https://github.com/thegridelectric/gridworks-base
+License: MIT
+Author: GridWorks
+Author-email: gridworks@gridworks-consulting.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: gridworks (>=1.1.3,<2.0.0)
+Requires-Dist: pika (>=1.3.2,<2.0.0)
+Requires-Dist: py-algorand-sdk (>=2.6.1)
+Requires-Dist: pydantic (>=1.10.2,<2.0.0)
+Requires-Dist: python-dotenv (>=1.0.0)
+Project-URL: Changelog, https://github.com/thegridelectric/gridworks-base/releases
+Project-URL: Documentation, https://gridworks-base.readthedocs.io
+Project-URL: Repository, https://github.com/thegridelectric/gridworks-base
+Description-Content-Type: text/markdown
+
+# Gridworks Base
+
+[![PyPI](https://img.shields.io/pypi/v/gridworks-base.svg)][pypi_]
+[![Status](https://img.shields.io/pypi/status/gridworks-base.svg)][status]
+[![Python Version](https://img.shields.io/pypi/pyversions/gridworks-base)][python version]
+[![License](https://img.shields.io/pypi/l/gridworks-base)][license]
+
+[![Read the documentation at https://gridworks-base.readthedocs.io/](https://img.shields.io/readthedocs/gridworks-base/latest.svg?label=Read%20the%20Docs)][read the docs]
+[![Tests](https://github.com/thegridelectric/gridworks-base/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/thegridelectric/gridworks-base/branch/main/graph/badge.svg)][codecov]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+
+[pypi_]: https://pypi.org/project/gridworks-base/
+[status]: https://pypi.org/project/gridworks-base/
+[python version]: https://pypi.org/project/gridworks-base
+[read the docs]: https://gridworks-base.readthedocs.io/
+[tests]: https://github.com/thegridelectric/gridworks-base/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/thegridelectric/gridworks-base
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+## Features
+
+- TODO
+
+## Requirements
+
+- TODO
+
+## Installation
+
+You can install _Gridworks Base_ via [pip] from [PyPI]:
+
+```console
+$ pip install gridworks-base
+```
+
+## Usage
+
+Please see the [Command-line Reference] for details.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_Gridworks Base_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
+
+[@cjolowicz]: https://github.com/cjolowicz
+[pypi]: https://pypi.org/
+[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+[file an issue]: https://github.com/thegridelectric/gridworks-base/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/thegridelectric/gridworks-base/blob/main/LICENSE
+[contributor guide]: https://github.com/thegridelectric/gridworks-base/blob/main/CONTRIBUTING.md
+[command-line reference]: https://gridworks-base.readthedocs.io/en/latest/usage.html
+

gridworks_base-0.0.1/README.md

@@ -0,0 +1,73 @@
+# Gridworks Base
+
+[![PyPI](https://img.shields.io/pypi/v/gridworks-base.svg)][pypi_]
+[![Status](https://img.shields.io/pypi/status/gridworks-base.svg)][status]
+[![Python Version](https://img.shields.io/pypi/pyversions/gridworks-base)][python version]
+[![License](https://img.shields.io/pypi/l/gridworks-base)][license]
+
+[![Read the documentation at https://gridworks-base.readthedocs.io/](https://img.shields.io/readthedocs/gridworks-base/latest.svg?label=Read%20the%20Docs)][read the docs]
+[![Tests](https://github.com/thegridelectric/gridworks-base/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/thegridelectric/gridworks-base/branch/main/graph/badge.svg)][codecov]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+
+[pypi_]: https://pypi.org/project/gridworks-base/
+[status]: https://pypi.org/project/gridworks-base/
+[python version]: https://pypi.org/project/gridworks-base
+[read the docs]: https://gridworks-base.readthedocs.io/
+[tests]: https://github.com/thegridelectric/gridworks-base/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/thegridelectric/gridworks-base
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+## Features
+
+- TODO
+
+## Requirements
+
+- TODO
+
+## Installation
+
+You can install _Gridworks Base_ via [pip] from [PyPI]:
+
+```console
+$ pip install gridworks-base
+```
+
+## Usage
+
+Please see the [Command-line Reference] for details.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_Gridworks Base_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
+
+[@cjolowicz]: https://github.com/cjolowicz
+[pypi]: https://pypi.org/
+[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+[file an issue]: https://github.com/thegridelectric/gridworks-base/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/thegridelectric/gridworks-base/blob/main/LICENSE
+[contributor guide]: https://github.com/thegridelectric/gridworks-base/blob/main/CONTRIBUTING.md
+[command-line reference]: https://gridworks-base.readthedocs.io/en/latest/usage.html

gridworks_base-0.0.1/pyproject.toml

@@ -0,0 +1,87 @@
+[tool.poetry]
+name = "gridworks-base"
+version = "0.0.1"
+description = "Gridworks Base"
+authors = ["GridWorks <gridworks@gridworks-consulting.com>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/thegridelectric/gridworks-base"
+repository = "https://github.com/thegridelectric/gridworks-base"
+documentation = "https://gridworks-base.readthedocs.io"
+packages = [
+    { include = "gwbase", from = "src" },
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+]
+
+[tool.poetry.urls]
+Changelog = "https://github.com/thegridelectric/gridworks-base/releases"
+
+[tool.poetry.dependencies]
+python = ">=3.11, <4.0"
+python-dotenv = ">=1.0.0"
+pydantic = "^1.10.2"
+
+pika = "^1.3.2"
+py-algorand-sdk = ">=2.6.1"
+gridworks = "^1.1.3"
+#gridworks = {path="../gridworks", develop=true}
+
+[tool.poetry.dev-dependencies]
+Pygments = ">=2.10.0"
+black = ">=21.10b0"
+coverage = {extras = ["toml"], version = ">=6.2"}
+darglint = ">=1.8.1"
+flake8 = ">=4.0.1"
+flake8-bandit = ">=2.1.2"
+flake8-bugbear = ">=21.9.2"
+flake8-docstrings = ">=1.6.0"
+flake8-rst-docstrings = ">=0.2.5"
+furo = ">=2021.11.12"
+isort = ">=5.10.1"
+mypy = ">=0.930"
+pep8-naming = ">=0.12.1"
+pre-commit = ">=2.16.0"
+pre-commit-hooks = ">=4.1.0"
+pytest = ">=6.2.5"
+pyupgrade = ">=2.29.1"
+safety = ">=1.10.3"
+sphinx = ">=4.3.2"
+sphinx-autobuild = ">=2021.3.14"
+sphinx-click = ">=3.0.2"
+typeguard = ">=2.13.3"
+xdoctest = {extras = ["colors"], version = ">=0.15.10"}
+myst-parser = {version = ">=0.16.1"}
+
+[tool.poetry.scripts]
+gridworks-base = "gwbase.__main__:main"
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+tests = ["tests", "*/tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["gwbase", "tests"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 100
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+lines_after_imports = 2
+
+[tool.mypy]
+strict = true
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

gridworks_base-0.0.1/src/gwbase/__init__.py

@@ -0,0 +1,8 @@
+"""Gridworks Base for rabbit actors."""
+
+import gw.errors as errors
+
+from gwbase.actor_base import ActorBase
+
+
+__all__ = ["errors", "ActorBase"]