Metadata-Version: 2.1
Name: numerous.sdk
Version: 0.11.0
License: MIT License
        
        Copyright (c) 2023 Energy Machines ApS
        
        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.
        
Project-URL: Homepage, https://numerous.com
Project-URL: Repository, https://gitlab.com/numerous/numerous.sdk
Project-URL: Documentation, https://numeroussdk.readthedocs.io
Project-URL: Changelog, https://gitlab.com/numerous/numerous.sdk/-/blob/main/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
License-File: LICENSE.txt

# numerous SDK

![pipeline](https://gitlab.com/numerous/numerous.sdk/badges/main/pipeline.svg)
![coverage](https://gitlab.com/numerous/numerous.sdk/badges/main/coverage.svg?job=pytest)

Welcome to the repository for `numerous.sdk`!

The `numerous.sdk` which includes all the things you need to build tools and
applications that can run on the [numerous platform](https://numerous.com).

## Dependencies

* This project requires python version 3.9 or later.

* Some dependencies are currently hosted on a pypi registry managed by the
  numerous platform team, which exists at https://pypi.numerously.com/simple.

  In the installation section below, we will show how to specify this, in order
  to properly install `numerous.sdk`.

## Installation

Some dependencies are hosted on the pypi registry
https://pypi.numerously.com/simple, which means that to install `numerous.sdk`
you must either:

1. Set the `PIP_EXTRA_INDEX_URL` environment variable
   ```
   export PIP_EXTRA_INDEX_URL="https://pypi.numerously.com/simple"
   pip install numerous.sdk
   ```
2. Use the `pip` flag `--extra-index-url`
   ```
   pip install --extra-index-url=ttps://pypi.numerously.com/simple numerous.sdk
   ```
3. Or add the pip flag to your `requirements.txt`, resulting in a file like
   below:
   ```
   --extra-index-url=https://pypi.numerously.com/simple
   numerous.sdk
   other_package
   ```
   which you can then install with
   ```
   pip install -r requirements.txt
   ```


## Documentation

Documentation for the numerous SDK can be found at
[readthedocs.io](https://numeroussdk.readthedocs.io). This contains the latest
documentation. We are continuously adding more, as the project matures.

## Contributing

We welcome contributions, but please read [CONTRIBUTING.md](CONTRIBUTING.md)
before you start. It lays down the processes and expectations of contributions
to the numerous SDK.

## Changes

See the [CHANGELOG.md](CHANGELOG.md) to get an overview latest features, fixes
and other changes to `numerous.sdk`, and also to find the general history of
changes.

## License

`numerous.sdk` is licensed under the MIT License, and it can be read in
[LICENSE.md](LICENSE.txt).
