Welcome to aiobearychat’s documentation!¶
Contents:
aiobearychat¶
An async BearyChat API library for Python
- Free software: MIT license
- Documentation: https://aiobearychat.readthedocs.org
- GitHub: https://github.com/mozillazg/aiobearychat
- PyPI: https://pypi.python.org/pypi/aiobearychat
- Python version: 3.5, 3.6
Usage¶
OpenAPI¶
import aiohttp
from aiobearychat.openapi.aiohttp import OpenAPI
async def main(token):
async with aiohttp.ClientSession() as session:
api = OpenAPI(session, token=token)
response = await api.user.list()
print(response.json())
Credits¶
This package was created with Cookiecutter and the mozillazg/cookiecutter-pypackage project template.
Installation¶
At the command line:
$ pip install aiobearychat
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv aiobearychat
$ pip install aiobearychat
开放 API (OpenAPI) 服务¶
使用示例¶
import aiohttp
from aiobearychat.openapi.aiohttp import OpenAPI
async def main(token):
async with aiohttp.ClientSession() as session:
api = OpenAPI(session, token=token)
response = await api.user.list()
print(response.json())
上面的 OpenAPI 是 aiobearychat.openapi.OpenAPI 的子类，表示使用
aiohttp 这个模块来进行 http 请求相关的操作。
具体 api 可以查看
aiobearychat.openapi.OpenAPI 的文档，同时也可以参考
官方文档 来理解
每个方法的含义。
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/mozillazg/aiobearychat/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
aiobearychat could always use more documentation, whether as part of the official aiobearychat docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/mozillazg/aiobearychat/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up aiobearychat for local development.
Fork the aiobearychat repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/aiobearychat.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv aiobearychat $ cd aiobearychat/ $ python setup.py developCreate a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 aiobearychat tests $ python setup.py test $ toxTo get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-featureSubmit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 3.5 and 3.6. Check https://travis-ci.org/mozillazg/aiobearychat/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- mozillazg <mozillazg101@gmail.com>
Contributors¶
None yet. Why not be the first?