optmanage 1.0.0.post0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. optmanage-1.0.0.post0/.gitattributes +4 -0
  2. optmanage-1.0.0.post0/.github/workflows/python-pytest.yml +41 -0
  3. optmanage-1.0.0.post0/.gitignore +136 -0
  4. optmanage-1.0.0.post0/.pylintrc +17 -0
  5. optmanage-1.0.0.post0/.readthedocs.yaml +64 -0
  6. optmanage-1.0.0.post0/CODE_OF_CONDUCT.md +128 -0
  7. optmanage-1.0.0.post0/CONTRIBUTING.md +98 -0
  8. optmanage-1.0.0.post0/LICENSE +21 -0
  9. optmanage-1.0.0.post0/PKG-INFO +107 -0
  10. optmanage-1.0.0.post0/README.rst +79 -0
  11. optmanage-1.0.0.post0/SECURITY.md +28 -0
  12. optmanage-1.0.0.post0/autodoc_typehints.py +380 -0
  13. optmanage-1.0.0.post0/docs/Makefile +23 -0
  14. optmanage-1.0.0.post0/docs/api/optmanage.manager.rst +12 -0
  15. optmanage-1.0.0.post0/docs/api/optmanage.option.rst +34 -0
  16. optmanage-1.0.0.post0/docs/api/optmanage.rst +12 -0
  17. optmanage-1.0.0.post0/docs/api-toc.rst +7 -0
  18. optmanage-1.0.0.post0/docs/autodoc-type-aliases.json +3 -0
  19. optmanage-1.0.0.post0/docs/conf.py +115 -0
  20. optmanage-1.0.0.post0/docs/getting-started.rst +106 -0
  21. optmanage-1.0.0.post0/docs/index.rst +52 -0
  22. optmanage-1.0.0.post0/docs/intersphinx/matplotlib-objects.inv +0 -0
  23. optmanage-1.0.0.post0/docs/intersphinx/networkx-objects.inv +0 -0
  24. optmanage-1.0.0.post0/docs/intersphinx/numpy-objects.inv +0 -0
  25. optmanage-1.0.0.post0/docs/intersphinx/pandas-objects.inv +0 -0
  26. optmanage-1.0.0.post0/docs/intersphinx/python-objects.inv +0 -0
  27. optmanage-1.0.0.post0/docs/intersphinx/scipy-objects.inv +0 -0
  28. optmanage-1.0.0.post0/docs/intersphinx/sympy-objects.inv +0 -0
  29. optmanage-1.0.0.post0/docs/intersphinx/typed-descriptors-objects.inv +0 -0
  30. optmanage-1.0.0.post0/docs/intersphinx/typing-validation-objects.inv +0 -0
  31. optmanage-1.0.0.post0/docs/make-api-clean-html.bat +4 -0
  32. optmanage-1.0.0.post0/docs/make-api.json +18 -0
  33. optmanage-1.0.0.post0/docs/make-api.py +267 -0
  34. optmanage-1.0.0.post0/docs/make.bat +39 -0
  35. optmanage-1.0.0.post0/docs/requirements.txt +6 -0
  36. optmanage-1.0.0.post0/fill-details.py +125 -0
  37. optmanage-1.0.0.post0/model.pylintrc +598 -0
  38. optmanage-1.0.0.post0/optmanage/__init__.py +20 -0
  39. optmanage-1.0.0.post0/optmanage/manager.py +227 -0
  40. optmanage-1.0.0.post0/optmanage/option.py +269 -0
  41. optmanage-1.0.0.post0/optmanage/py.typed +0 -0
  42. optmanage-1.0.0.post0/optmanage.egg-info/PKG-INFO +107 -0
  43. optmanage-1.0.0.post0/optmanage.egg-info/SOURCES.txt +55 -0
  44. optmanage-1.0.0.post0/optmanage.egg-info/dependency_links.txt +1 -0
  45. optmanage-1.0.0.post0/optmanage.egg-info/requires.txt +8 -0
  46. optmanage-1.0.0.post0/optmanage.egg-info/top_level.txt +1 -0
  47. optmanage-1.0.0.post0/pypi-upload.bat +4 -0
  48. optmanage-1.0.0.post0/pyproject.toml +13 -0
  49. optmanage-1.0.0.post0/requirements.txt +1 -0
  50. optmanage-1.0.0.post0/run-black.bat +2 -0
  51. optmanage-1.0.0.post0/run-tests.bat +6 -0
  52. optmanage-1.0.0.post0/setup.cfg +45 -0
  53. optmanage-1.0.0.post0/test/__init__.py +0 -0
  54. optmanage-1.0.0.post0/test/test_00_option.py +46 -0
  55. optmanage-1.0.0.post0/test/test_01_manager.py +144 -0
  56. optmanage-1.0.0.post0/tox.ini +18 -0
@@ -0,0 +1,4 @@
1
+ docs/* linguist-documentation
2
+ htmlcov/* linguist-vendored
3
+ test/* linguist-vendored
4
+ *.bat -linguist-detectable
@@ -0,0 +1,41 @@
1
+ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2
+ # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3
+
4
+ name: Python package
5
+
6
+ on:
7
+ push:
8
+ branches: [ main ]
9
+ pull_request:
10
+ branches: [ main ]
11
+
12
+ jobs:
13
+ build:
14
+
15
+ runs-on: ubuntu-latest
16
+ strategy:
17
+ fail-fast: false
18
+ matrix:
19
+ python-version: ["3.10", "3.11", "3.12"]
20
+
21
+ steps:
22
+ - uses: actions/checkout@v2
23
+ - name: Set up Python ${{ matrix.python-version }}
24
+ uses: actions/setup-python@v2
25
+ with:
26
+ python-version: ${{ matrix.python-version }}
27
+ - name: Install dependencies
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ python -m pip install mypy pylint pytest
31
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
32
+ - name: Test with pytest
33
+ run: |
34
+ pytest
35
+ - name: Lint with mypy
36
+ run: |
37
+ mypy --strict optmanage
38
+ - name: Lint with pylint
39
+ run: |
40
+ pylint --errors-only --rcfile=.pylintrc optmanage
41
+ pylint --exit-zero --rcfile=.pylintrc optmanage
@@ -0,0 +1,136 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .env
106
+ .venv
107
+ env/
108
+ venv/
109
+ ENV/
110
+ env.bak/
111
+ venv.bak/
112
+
113
+ # Spyder project settings
114
+ .spyderproject
115
+ .spyproject
116
+
117
+ # Rope project settings
118
+ .ropeproject
119
+
120
+ # mkdocs documentation
121
+ /site
122
+
123
+ # mypy
124
+ .mypy_cache/
125
+ .dmypy.json
126
+ dmypy.json
127
+
128
+ # Pyre type checker
129
+ .pyre/
130
+
131
+ # Misc
132
+
133
+ # pypi-upload.bat
134
+ # model.pylintrc
135
+ README-PROOF.html
136
+ .vscode/settings.json
@@ -0,0 +1,17 @@
1
+ [MESSAGES CONTROL]
2
+ disable = too-many-ancestors,
3
+ too-few-public-methods,
4
+ invalid-name,
5
+ unused-argument,
6
+ redefined-outer-name,
7
+ useless-super-delegation,
8
+ isinstance-second-argument-not-valid-type,
9
+ broad-except,
10
+ too-many-lines,
11
+ wildcard-import,
12
+ unused-wildcard-import,
13
+ protected-access,
14
+ useless-import-alias,
15
+ duplicate-code,
16
+ [FORMAT]
17
+ max-line-length=80
@@ -0,0 +1,64 @@
1
+ # Read the Docs configuration file for Sphinx projects
2
+
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+
6
+ # Required
7
+
8
+ version: 2
9
+
10
+
11
+ # Set the OS, Python version and other tools you might need
12
+
13
+ build:
14
+
15
+ os: ubuntu-22.04
16
+
17
+ tools:
18
+
19
+ python: "3.12"
20
+
21
+ # You can also specify other tool versions:
22
+
23
+ # nodejs: "20"
24
+
25
+ # rust: "1.70"
26
+
27
+ # golang: "1.20"
28
+
29
+
30
+ # Build documentation in the "docs/" directory with Sphinx
31
+
32
+ sphinx:
33
+
34
+ configuration: docs/conf.py
35
+
36
+ # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
37
+
38
+ # builder: "dirhtml"
39
+
40
+ # Fail on all warnings to avoid broken references
41
+
42
+ # fail_on_warning: true
43
+
44
+
45
+ # Optionally build your docs in additional formats such as PDF and ePub
46
+
47
+ # formats:
48
+
49
+ # - pdf
50
+
51
+ # - epub
52
+
53
+
54
+ # Optional but recommended, declare the Python requirements required
55
+
56
+ # to build your documentation
57
+
58
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
59
+
60
+ python:
61
+
62
+ install:
63
+
64
+ - requirements: docs/requirements.txt
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ community@hashberg.io.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
@@ -0,0 +1,98 @@
1
+
2
+ # Contributing
3
+
4
+ All contributions, big and small, are very appreciated!
5
+ [File an issue](#file-an-issue) for bug reports, suggestions and questions, or [make a pull request](#make-a-pull-request) to actively contribute to the code or documentation.
6
+
7
+ However you decide to help, please refer to our [code of conduct](CODE_OF_CONDUCT.md) for what we expect from our community.
8
+
9
+
10
+ ## File an Issue
11
+
12
+ Issues can be filed at https://github.com/hashberg-io/optmanage/issues. You can file an issue to:
13
+
14
+ - report a bug (using the `bug` label)
15
+ - suggest a new feature (using the `enhancement` label)
16
+ - suggest improvements to our documentation (using the `documentation` label)
17
+ - ask for information and start a discussion thread (using the `question` label)
18
+
19
+ If you are reporting a bug, please include the following information:
20
+
21
+ - project version (PyPI version number or commit number)
22
+ - Python version
23
+ - version of installed dependencies
24
+ - how the bug manifests (e.g. what you expect to happen vs what actually happens)
25
+ - how others can reproduce the bug
26
+
27
+ Please try to be concise in your description, providing a minimal reproducible example whenever possible.
28
+
29
+ If you're proposing a new feature, please describe it in detail, with a few examples of it might be implemented and of its intended usage.
30
+
31
+
32
+ ## Make a Pull Request
33
+
34
+ You can [make a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to:
35
+
36
+ - fix a bug which is reported and discussed in an open issue
37
+ - implement a new feature which is suggested and discussed in an open issue
38
+ - improve our documentation in ways suggested and discussed in an open issue
39
+
40
+ You should [link your pull request to the issue(s)](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) that it addresses. Once your pull request passes all continuous integration checks, we will review it and either:
41
+
42
+ - approve the pull request and merge it
43
+ - start a discussion on how to improve the pull request before it can be approved
44
+ - reject the pull request, with an explanation as to why we don't consider it viable for improvement
45
+
46
+
47
+ ### Continuous Integration
48
+
49
+ You can perform continuous integration checks on all supported versions by running [tox](https://tox.readthedocs.io/en/latest/) in the main project folder:
50
+
51
+ ```
52
+ tox
53
+ ```
54
+
55
+ Continuous integration involves the following individual checks:
56
+
57
+ 1. testing with [pytest](https://docs.pytest.org/):
58
+
59
+ ```
60
+ pytest
61
+ ```
62
+
63
+ 2. static type-checking with [mypy](http://mypy-lang.org/):
64
+
65
+ ```
66
+ mypy --strict optmanage
67
+ ```
68
+
69
+ 3. linting with [pylint](https://www.pylint.org/):
70
+
71
+ ```
72
+ pylint --errors-only optmanage
73
+ pylint --exit-zero optmanage
74
+ ```
75
+
76
+ Whenever relevant, please consider contributing some additional tests pertaining to your implementation.
77
+
78
+
79
+ ### Documentation
80
+
81
+ The API documentation for this project is generated by [Sphinx](https://www.sphinx-doc.org/): please document any code changes and additions using [reST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) docstrings. The documentation is generated by running the following commands in the [docs/](docs/) folder:
82
+
83
+ ```
84
+ docs>make api
85
+ docs>make clean
86
+ docs>make html
87
+ ```
88
+
89
+ The script `make-api-clean-html.bat` automates the procedure on Windows. If you edit the [readme page](README.rst), please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
90
+
91
+
92
+ ### Code Formatting
93
+
94
+ Code should be formatted by [Black](https://github.com/psf/black):
95
+
96
+ ```
97
+ black -l 80 -t py38 -t py39 -t py310 -t py311 -t py312 .\optmanage
98
+ ```
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Hashberg
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,107 @@
1
+ Metadata-Version: 2.1
2
+ Name: optmanage
3
+ Version: 1.0.0.post0
4
+ Summary: A library to create flexible option managers.
5
+ Home-page: https://github.com/hashberg-io/optmanage
6
+ Author: hashberg
7
+ Author-email: sg495@users.noreply.github.com
8
+ Project-URL: Bug Tracker, https://github.com/hashberg-io/optmanage/issues
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Programming Language :: Python :: 3.12
11
+ Classifier: Programming Language :: Python :: 3.11
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Natural Language :: English
17
+ Classifier: Typing :: Typed
18
+ Requires-Python: >=3.10
19
+ Description-Content-Type: text/x-rst
20
+ License-File: LICENSE
21
+ Requires-Dist: typing-extensions>=4.6.0
22
+ Requires-Dist: typing-validation>=1.2.4
23
+ Provides-Extra: dev
24
+ Requires-Dist: mypy; extra == "dev"
25
+ Requires-Dist: pylint; extra == "dev"
26
+ Requires-Dist: pytest; extra == "dev"
27
+ Requires-Dist: pytest-cov; extra == "dev"
28
+
29
+ optmanage: A library to create flexible option managers.
30
+ ========================================================
31
+
32
+ .. image:: https://img.shields.io/badge/python-3.10+-green.svg
33
+ :target: https://docs.python.org/3.10/
34
+ :alt: Python versions
35
+
36
+ .. image:: https://img.shields.io/pypi/v/optmanage.svg
37
+ :target: https://pypi.python.org/pypi/optmanage/
38
+ :alt: PyPI version
39
+
40
+ .. image:: https://img.shields.io/pypi/status/optmanage.svg
41
+ :target: https://pypi.python.org/pypi/optmanage/
42
+ :alt: PyPI status
43
+
44
+ .. image:: http://www.mypy-lang.org/static/mypy_badge.svg
45
+ :target: https://github.com/python/mypy
46
+ :alt: Checked with Mypy
47
+
48
+ .. image:: https://readthedocs.org/projects/optmanage/badge/?version=latest
49
+ :target: https://optmanage.readthedocs.io/en/latest/?badge=latest
50
+ :alt: Documentation Status
51
+
52
+ .. image:: https://github.com/hashberg-io/optmanage/actions/workflows/python-pytest.yml/badge.svg
53
+ :target: https://github.com/hashberg-io/optmanage/actions/workflows/python-pytest.yml
54
+ :alt: Python package status
55
+
56
+ .. image:: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square
57
+ :target: https://github.com/RichardLitt/standard-readme
58
+ :alt: standard-readme compliant
59
+
60
+
61
+ A library to create flexible option managers.
62
+
63
+ .. contents::
64
+
65
+
66
+ Install
67
+ -------
68
+
69
+ This project is currently in private development. At present, you should clone the repository and install it locally as follows:
70
+
71
+ .. code-block:: console
72
+
73
+ $ pip install --upgrade .
74
+
75
+
76
+ One the package is published, you will be able to install the latest release from `PyPI <https://pypi.org/project/optmanage/>`_ as follows:
77
+
78
+ .. code-block:: console
79
+
80
+ $ pip install --upgrade optmanage
81
+
82
+
83
+ Usage
84
+ -----
85
+
86
+ This project is currently in private development. For usage examples, refer to the ``notebooks`` folder.
87
+
88
+
89
+
90
+ API
91
+ ---
92
+
93
+ At present, documentation is built locally by the script ``docs/make-api-clean-html.bat``, and subsequently accessed from ``docs/_build/html/index.html``.
94
+
95
+ One the package is published, the full API documentation will be available at https://optmanage.readthedocs.io/
96
+
97
+
98
+ Contributing
99
+ ------------
100
+
101
+ This project is currently in private development. Public contribution guidelines are available at `<CONTRIBUTING.md>`_.
102
+
103
+
104
+ License
105
+ -------
106
+
107
+ `LGPL © Hashberg Ltd. <LICENSE>`_
@@ -0,0 +1,79 @@
1
+ optmanage: A library to create flexible option managers.
2
+ ========================================================
3
+
4
+ .. image:: https://img.shields.io/badge/python-3.10+-green.svg
5
+ :target: https://docs.python.org/3.10/
6
+ :alt: Python versions
7
+
8
+ .. image:: https://img.shields.io/pypi/v/optmanage.svg
9
+ :target: https://pypi.python.org/pypi/optmanage/
10
+ :alt: PyPI version
11
+
12
+ .. image:: https://img.shields.io/pypi/status/optmanage.svg
13
+ :target: https://pypi.python.org/pypi/optmanage/
14
+ :alt: PyPI status
15
+
16
+ .. image:: http://www.mypy-lang.org/static/mypy_badge.svg
17
+ :target: https://github.com/python/mypy
18
+ :alt: Checked with Mypy
19
+
20
+ .. image:: https://readthedocs.org/projects/optmanage/badge/?version=latest
21
+ :target: https://optmanage.readthedocs.io/en/latest/?badge=latest
22
+ :alt: Documentation Status
23
+
24
+ .. image:: https://github.com/hashberg-io/optmanage/actions/workflows/python-pytest.yml/badge.svg
25
+ :target: https://github.com/hashberg-io/optmanage/actions/workflows/python-pytest.yml
26
+ :alt: Python package status
27
+
28
+ .. image:: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square
29
+ :target: https://github.com/RichardLitt/standard-readme
30
+ :alt: standard-readme compliant
31
+
32
+
33
+ A library to create flexible option managers.
34
+
35
+ .. contents::
36
+
37
+
38
+ Install
39
+ -------
40
+
41
+ This project is currently in private development. At present, you should clone the repository and install it locally as follows:
42
+
43
+ .. code-block:: console
44
+
45
+ $ pip install --upgrade .
46
+
47
+
48
+ One the package is published, you will be able to install the latest release from `PyPI <https://pypi.org/project/optmanage/>`_ as follows:
49
+
50
+ .. code-block:: console
51
+
52
+ $ pip install --upgrade optmanage
53
+
54
+
55
+ Usage
56
+ -----
57
+
58
+ This project is currently in private development. For usage examples, refer to the ``notebooks`` folder.
59
+
60
+
61
+
62
+ API
63
+ ---
64
+
65
+ At present, documentation is built locally by the script ``docs/make-api-clean-html.bat``, and subsequently accessed from ``docs/_build/html/index.html``.
66
+
67
+ One the package is published, the full API documentation will be available at https://optmanage.readthedocs.io/
68
+
69
+
70
+ Contributing
71
+ ------------
72
+
73
+ This project is currently in private development. Public contribution guidelines are available at `<CONTRIBUTING.md>`_.
74
+
75
+
76
+ License
77
+ -------
78
+
79
+ `LGPL © Hashberg Ltd. <LICENSE>`_