Metadata-Version: 2.1
Name: idservice
Version: 0.3.0
Summary: ID-Service is a distributed ID generator microservice based on FastAPI
Home-page: https://github.com/pypa/sampleproject
Author: The Python Packaging Authority
Author-email: pypa-dev@googlegroups.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/tommyxu/idservice/issues
Project-URL: Source, https://github.com/tommyxu/idservice
Keywords: distributed id service setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4
Description-Content-Type: text/markdown
Requires-Dist: configprops (==1.1.0)
Requires-Dist: fastapi (==0.63.0)
Requires-Dist: gunicorn (==20.0.4)
Requires-Dist: httptools (==0.1.1)
Requires-Dist: ptable (==0.9.2)
Requires-Dist: python-dotenv (==0.15.0)
Requires-Dist: pyyaml (==5.4.1)
Requires-Dist: typing-extensions (==3.7.4.3)
Requires-Dist: uvicorn[standard] (==0.13.4)
Requires-Dist: uvloop (==0.15.2)
Requires-Dist: watchgod (==0.7)
Requires-Dist: websockets (==8.1)
Requires-Dist: pydantic (==1.8.1) ; python_full_version >= "3.6.1"
Requires-Dist: click (==7.1.2) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3, 3.4"
Requires-Dist: h11 (==0.12.0) ; python_version >= "3.6"
Requires-Dist: starlette (==0.13.6) ; python_version >= "3.6"
Provides-Extra: dev

# idservice

`ID-Service` is a distributed ID generator microservice based on FastAPI.

## Installation

```sh
pip3 install idservice
```

## Start Service

```sh
idservice-start
```

> List all available `Gunicorn` options by `idservice-start --help`

## API Endpoint

Several endpoints:

-   `/id/snowflake`
-   `/id/random/64`
-   `/id/uuid`

Browse `/docs` (default to http://localhost:8000/docs) to read all APIs.

## Configuration

Environment variable:

| Environment Vars        | Usage                                  | Default        |
| ----------------------- | -------------------------------------- | -------------- |
| `ID_SERVICE_MACHINE_ID` | Snowflake Machine ID (10 bits integer) | Random (0-255) |


