Skip to content

Commit 2fb327e

Browse files
committed
docs: Update some documents
1 parent 3b87aae commit 2fb327e

File tree

5 files changed

+104
-19
lines changed

5 files changed

+104
-19
lines changed

.gitignore

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,66 @@
1-
*.pyc
2-
.idea
3-
*.log
1+
# Compiler
2+
.idea/
3+
.vscode/
4+
5+
# Byte-compiled / optimized / DLL files / logs
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
*.log
10+
11+
12+
# Distribution / packaging
13+
.Python
14+
build/
15+
develop-eggs/
16+
dist/
17+
downloads/
18+
eggs/
19+
.eggs/
20+
lib/
21+
lib64/
22+
parts/
23+
sdist/
24+
var/
25+
wheels/
26+
share/python-wheels/
27+
*.egg-info/
28+
.installed.cfg
29+
*.egg
30+
MANIFEST
31+
32+
# Installer logs
33+
pip-log.txt
34+
pip-delete-this-directory.txt
35+
36+
# Unit test / coverage reports
37+
htmlcov/
38+
.tox/
39+
.nox/
40+
.coverage
41+
.coverage.*
42+
.cache
43+
nosetests.xml
44+
coverage.xml
45+
*.cover
46+
*.py,cover
47+
.hypothesis/
48+
.pytest_cache/
49+
cover/
50+
51+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
52+
__pypackages__/
53+
54+
# Environments
55+
.env
56+
.venv
57+
env/
58+
venv/
59+
ENV/
60+
env.bak/
61+
venv.bak/
62+
63+
# mypy
64+
.mypy_cache/
65+
.dmypy.json
66+
dmypy.json

.license-ignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@
99
.asf.yaml
1010
LICENSE
1111
NOTICE
12-
README.md
13-
requirements.txt
1412
requirements-dev.txt
15-
rat-report.txt
1613

1714
# directories
1815
.vscode
@@ -21,5 +18,3 @@ rat-report.txt
2118
.gitignore
2219
.license-ignore
2320
./samples/proto/*
24-
25-

CONTRIBUTING.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,24 @@ git push origin your_awesome_patch
5858

5959
Thanks for contributing!
6060

61+
62+
63+
### Development & Testing
64+
65+
Before you start working on development, please install the necessary dependencies for Dubbo-Python using the following command:
66+
67+
```shell
68+
pip install -r requirements-dev.txt
69+
```
70+
71+
Our project uses a `src` layout, and packaging is required before running tests. We strongly recommend using the **editable installation mode** for packaging and testing:
72+
73+
```shell
74+
pip install -e .
75+
```
76+
77+
78+
6179
### Code style
6280

6381
We use **ruff** as the linter and code formatter for Dubbo-Python, and **Mypy** as the static type checker.
@@ -73,7 +91,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
7391

7492
By default, ruff will look for the `pyproject.toml` file in the current directory and its parent directories and load its configuration.
7593

76-
```bash
94+
```shell
7795
# Default
7896
ruff format
7997

@@ -83,7 +101,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
83101

84102
2. Code Linting
85103

86-
```bash
104+
```shell
87105
# Just check
88106
ruff check
89107
@@ -95,7 +113,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
95113

96114
Mypy will also automatically look for the `pyproject.toml` file and load its configuration.
97115

98-
```bash
116+
```shell
99117
# Default
100118
mypy
101119

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Apache Dubbo for Python
22

3-
![License](https://img.shields.io/github/license/apache/dubbo-python)
3+
![License](https://img.shields.io/github/license/apache/dubbo-python?logo=apache&logoColor=red&label=LICENSE)
44
![GitHub last commit](https://img.shields.io/github/last-commit/apache/dubbo-python)
55
![GitHub branch check runs](https://img.shields.io/github/check-runs/apache/dubbo-python/main)
6-
7-
---
6+
![PyPI - Version](https://img.shields.io/pypi/v/apache-dubbo?logo=pypi&logoColor=gold&label=PyPI&color=blue)
7+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/apache-dubbo?logo=python&logoColor=gold&label=Python)
88

99
<p align="center">
1010
<img src="https://cn.dubbo.apache.org/imgs/nav_logo2.png" alt="Logo" width="40%" />
@@ -29,19 +29,22 @@ Visit [the official website](https://dubbo.apache.org/) for more information.
2929
- **Serialization**: Customizable(protobuf, json...)
3030

3131

32-
3332
## Installation
3433

35-
Before you start, make sure you have **`python 3.11+`** installed.
34+
Before you start, make sure you have **`python 3.9+`** installed.
35+
36+
1. Install Directly
3637

37-
1. Install from source
38+
```sh
39+
pip install apache-dubbo
40+
```
41+
2. Install from source
3842

3943
```sh
4044
git clone https://github.com/apache/dubbo-python.git
4145
cd dubbo-python && pip install .
4246
```
4347

44-
4548
## Getting started
4649

4750
Get up and running with Dubbo-Python in just 5 minutes by following our [Quick Start Guide](https://github.com/apache/dubbo-python/tree/main/samples).
@@ -116,7 +119,11 @@ It's as simple as the code snippet below. With just a few lines of code, you can
116119

117120
```
118121

119-
122+
## Contributing
123+
124+
We are excited to welcome contributions to the Dubbo-Python project! Whether you are fixing bugs, adding new features, or improving documentation, your input is highly valued.
125+
126+
To ensure a smooth collaboration, please review our [Contributing Guide](https://github.com/apache/dubbo-python/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started, adhere to coding standards, and submit your contributions effectively.
120127

121128
## License
122129

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ classifiers=[
4141
"Programming Language :: Python :: 3.9",
4242
"Programming Language :: Python :: 3.10",
4343
"Programming Language :: Python :: 3.11",
44+
"Programming Language :: Python :: 3.12",
45+
"Programming Language :: Python :: 3.13",
4446
"Framework :: AsyncIO",
4547
"Topic :: Internet",
4648
"Topic :: Internet :: WWW/HTTP",

0 commit comments

Comments
 (0)