{"id":19466776,"url":"https://github.com/zulip/python-zulip-api","last_synced_at":"2025-05-14T01:02:36.550Z","repository":{"id":37271253,"uuid":"96455158","full_name":"zulip/python-zulip-api","owner":"zulip","description":"Python library for the Zulip API.","archived":false,"fork":false,"pushed_at":"2025-04-07T19:14:43.000Z","size":5510,"stargazers_count":372,"open_issues_count":137,"forks_count":393,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-04-13T08:05:03.900Z","etag":null,"topics":["python","python3","zulip"],"latest_commit_sha":null,"homepage":"https://zulip.com/api/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zulip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"zulip","patreon":"zulip","open_collective":"zulip"}},"created_at":"2017-07-06T17:25:46.000Z","updated_at":"2025-04-07T19:24:44.000Z","dependencies_parsed_at":"2023-01-28T04:31:27.734Z","dependency_job_id":"9dce2fa2-6e97-45db-814a-c5d60f2f30b5","html_url":"https://github.com/zulip/python-zulip-api","commit_stats":{"total_commits":2407,"total_committers":165,"mean_commits":"14.587878787878788","dds":0.7748234316576652,"last_synced_commit":"0c92097bd76c3c7663d908770323da40736cd475"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zulip%2Fpython-zulip-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zulip%2Fpython-zulip-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zulip%2Fpython-zulip-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zulip%2Fpython-zulip-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zulip","download_url":"https://codeload.github.com/zulip/python-zulip-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681494,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","python3","zulip"],"created_at":"2024-11-10T18:30:10.405Z","updated_at":"2025-04-14T22:14:03.690Z","avatar_url":"https://github.com/zulip.png","language":"Python","readme":"# Zulip API\n\n[![Build status](https://github.com/zulip/python-zulip-api/workflows/build/badge.svg)](\nhttps://github.com/zulip/python-zulip-api/actions?query=branch%3Amain+workflow%3Abuild)\n[![Coverage status](https://img.shields.io/codecov/c/github/zulip/python-zulip-api)](\nhttps://codecov.io/gh/zulip/python-zulip-api)\n\nThis repository contains the source code for Zulip's PyPI packages:\n\n* `zulip`: [PyPI package](https://pypi.python.org/pypi/zulip/)\n  for Zulip's API bindings.\n* `zulip_bots`: [PyPI package](https://pypi.python.org/pypi/zulip-bots)\n  for Zulip's bots and bots API.\n* `zulip_botserver`: [PyPI package](https://pypi.python.org/pypi/zulip-botserver)\n  for Zulip's Flask Botserver.\n\nThe source code is written in *Python 3*.\n\n## Development\n\nThis is part of the Zulip open source project; see the\n[contributing guide](https://zulip.readthedocs.io/en/latest/overview/contributing.html)\nand [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/version-control.html).\n\n1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:\n   ```\n   git clone https://github.com/\u003cyour_username\u003e/python-zulip-api.git\n   cd python-zulip-api\n   git remote add upstream https://github.com/zulip/python-zulip-api.git\n   git fetch upstream\n   ```\n\n2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/).\n\n3. Run:\n   ```\n   python3 ./tools/provision\n   ```\n   This sets up a virtual Python environment in `zulip-api-py\u003cyour_python_version\u003e-venv`,\n   where `\u003cyour_python_version\u003e` is your default version of Python. If you would like to specify\n   a different Python version, run\n   ```\n   python3 ./tools/provision -p \u003cpath_to_your_python_version\u003e\n   ```\n\n4. If that succeeds, it will end with printing the following command:\n   ```\n   source /.../python-zulip-api/.../activate\n   ```\n   You can run this command to enter the virtual environment.\n   You'll want to run this in each new shell before running commands from `python-zulip-api`.\n\n5. Once you've entered the virtualenv, you should see something like this on the terminal:\n   ```\n   (zulip-api-py3-venv) user@pc ~/python-zulip-api $\n   ```\n   You should now be able to run any commands/tests/etc. in this\n   virtual environment.\n\n### Running tests\n\nYou can run all the tests with:\n\n`pytest`\n\nor test individual packages with `pytest zulip`, `pytest zulip_bots`,\nor `pytest zulip_botserver` (see the [pytest\ndocumentation](https://docs.pytest.org/en/latest/how-to/usage.html)\nfor more options).\n\nTo run the linter, type:\n\n`./tools/lint`\n\nTo check the type annotations, run:\n\n`./tools/run-mypy`\n","funding_links":["https://github.com/sponsors/zulip","https://patreon.com/zulip","https://opencollective.com/zulip"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzulip%2Fpython-zulip-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzulip%2Fpython-zulip-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzulip%2Fpython-zulip-api/lists"}