diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 0b39238f..28b54e70 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -23,4 +23,5 @@ If you're looking to add functionality to Home Assistant you will need to do the - https://www.teslaapi.io/ - https://tesla-api.timdorr.com/ 2. Build a proper abstraction inheriting from the [vehicle.py](teslajsonpy/vehicle.py). Check out [lock.py](teslajsonpy/lock.py). +3. Add abstraction to the controller [_add_components](https://github.com/zabuldon/teslajsonpy/blob/dev/teslajsonpy/controller.py#L530) so it will be discoverable. 3. Add changes to Home Assistant to access your abstraction and submit a PR per HA guidelines. diff --git a/README.md b/README.md index 33bfa62b..33ea077a 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,9 @@ Also thanks to [Tim Dorr](https://tesla-api.timdorr.com/) for documenting the AP 11. Add yourself to `AUTHORS.md`. 12. Submit a [pull request](https://github.com/zabuldon/teslajsonpy/pulls)! +# Documentation +[API docs](https://teslajsonpy.readthedocs.io/en/latest/). + # License [Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0. diff --git a/pyproject.toml b/pyproject.toml index cf762cef..fbff8b0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,6 +5,25 @@ description = "A library to work with Tesla API." authors = ["Sergey Isachenko "] license = "Apache-2.0" repository = "https://github.com/zabuldon/teslajsonpy" +readme = "README.md" +homepage = "https://github.com/zabuldon/teslajsonpy" +documentation = "https://teslajsonpy.readthedocs.io" +classifiers = [ + "Development Status :: 3 - Alpha", + "Natural Language :: English", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Intended Audience :: Developers", + "Operating System :: OS Independent", + "Environment :: Console", + "Topic :: Software Development :: Libraries :: Python Modules" +] +include = [ + "README.md", + "LICENSE", + "CHANGELOG.md" +] [tool.poetry.dependencies] python = "^3.6.1" @@ -35,3 +54,7 @@ pylint = "^2.7.3" [build-system] requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" + +[metadata] +description-file = "README.md" +