python-zulip-api - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #golang #go #android #machine-learning #rust #deep-learning #java #windows #awesome #pytorch #mcp

python-zulip-api

(★ 402)

Python library for the Zulip API.

File Explorer

Download Latest Version (.zip)

- - zulip-ci.yml
  - zulip-tests.yml
- FUNDING.yml
- pull_request_template.md
- - __init__.py
  - doc.md
  - packaged_helloworld.py
- README.md
- setup.py
- .coveragerc
- clean-branches
- clean-repo
- custom_check.py
- deploy
- deploy-branch
- fetch-pull-request
- fetch-rebase-pull-request
- gitlint-rules.py
- lint
- lint-commits
- provision
- reset-to-pull-request
- review
- run-mypy
- - __init__.py
- - __init__.py
  - test_default_arguments.py
  - test_hash_util_decode.py
- - __init__.py
  - api_examples.py
  - cli.py
  - py.typed
  - send.py
- CHANGELOG.md
- MANIFEST.in
- README.md
- setup.cfg
- setup.py
- - .gitignore
  - __init__.py
  - bot_shell.py
  - custom_exceptions.py
  - finder.py
  - game_handler.py
  - lib.py
  - provision.py
  - py.typed
  - request_test_lib.py
  - run.py
  - simple_lib.py
  - test_file_utils.py
  - test_lib.py
- architecture.md
- README.md
- setup.py
- - __init__.py
  - server_test_lib.py
  - test.conf
  - test_server.py
- - __init__.py
  - input_parameters.py
  - py.typed
  - server.py
- README.md
- setup.py
- zulip-botserver-supervisord.conf
.codecov.yml
.editorconfig
.gitignore
.gitlint
.mailmap
LICENSE
NOTICE
pyproject.toml
README.md
requirements.txt
THIRDPARTY

# Installation Guide

1. Get the code

git clone https://github.com/zulip/python-zulip-api

Downloads the entire project code from GitHub to your computer.

cd python-zulip-api

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Zulip API

[![Build status](https://github.com/zulip/python-zulip-api/workflows/build/badge.svg)](https://github.com/zulip/python-zulip-api/actions)
[![Coverage status](https://img.shields.io/codecov/c/github/zulip/python-zulip-api)](https://codecov.io/gh/zulip/python-zulip-api)

This repository contains the source code for Zulip's PyPI packages:

* `zulip`: [PyPI package](https://pypi.python.org/pypi/zulip/)
  for Zulip's API bindings.
* `zulip_bots`: [PyPI package](https://pypi.python.org/pypi/zulip-bots)
  for Zulip's bots and bots API.
* `zulip_botserver`: [PyPI package](https://pypi.python.org/pypi/zulip-botserver)
  for Zulip's Flask Botserver.

The source code is written in *Python 3*.

## Development

This is part of the Zulip open source project; see the
[contributing guide](https://zulip.readthedocs.io/en/latest/overview/contributing.html)
and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/version-control.html).

1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:
   ```
   git clone https://github.com/<your_username>/python-zulip-api.git
   cd python-zulip-api
   git remote add upstream https://github.com/zulip/python-zulip-api.git
   git fetch upstream
   ```

2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/).

3. Run:
   ```
   python3 ./tools/provision
   ```
   This sets up a virtual Python environment in `zulip-api-py<your_python_version>-venv`,
   where `<your_python_version>` is your default version of Python. If you would like to specify
   a different Python version, run
   ```
   python3 ./tools/provision -p <path_to_your_python_version>
   ```

4. If that succeeds, it will end with printing the following command:
   ```
   source /.../python-zulip-api/.../activate
   ```
   You can run this command to enter the virtual environment.
   You'll want to run this in each new shell before running commands from `python-zulip-api`.

5. Once you've entered the virtualenv, you should see something like this on the terminal:
   ```
   (zulip-api-py3-venv) user@pc ~/python-zulip-api $
   ```
   You should now be able to run any commands/tests/etc. in this
   virtual environment.

### Running tests

You can run all the tests with:

`pytest`

or test individual packages with `pytest zulip`, `pytest zulip_bots`,
or `pytest zulip_botserver` (see the [pytest
documentation](https://docs.pytest.org/en/latest/how-to/usage.html)
for more options).

To run the linter, type:

`./tools/lint`

To check the type annotations, run:

`./tools/run-mypy`