PyCantonese: Cantonese Linguistics and NLP in Python
Full Documentation: https://pycantonese.org
PyCantonese is a Python library for Cantonese linguistics and natural language processing (NLP). Currently implemented features (more to come!):
Accessing and searching corpus data
Parsing and conversion tools for Jyutping romanization
Parsing Cantonese text
Stop words
Word segmentation
Part-of-speech tagging
Download and Install
To download and install the stable, most recent version:
$ pip install --upgrade pycantonese
Ready for more? Check out the Quickstart page.
Consulting
If your team would like professional assistance in using PyCantonese, freelance consulting and training services are available for both academic and commercial groups. Please email Jackson L. Lee.
Support
If you have found PyCantonese useful and would like to offer support, buying me a coffee would go a long way!
Links
Source code: https://github.com/jacksonllee/pycantonese
Bug tracker: https://github.com/jacksonllee/pycantonese/issues
How to Cite
PyCantonese is authored and maintained by Jackson L. Lee.
A talk introducing PyCantonese:
Lee, Jackson L. 2015. PyCantonese: Cantonese linguistic research in the age of big data. Talk at the Childhood Bilingualism Research Centre, Chinese University of Hong Kong. September 15. 2015. Notes+slides
License
MIT License. Please see LICENSE.txt in the GitHub source code for details.
The HKCanCor dataset included in PyCantonese is substantially modified from its source in terms of format. The original dataset has a CC BY license. Please see pycantonese/data/hkcancor/README.md in the GitHub source code for details.
The rime-cantonese data (release 2021.05.16) is incorporated into PyCantonese for word segmentation and characters-to-Jyutping conversion. This data has a CC BY 4.0 license. Please see pycantonese/data/rime_cantonese/README.md in the GitHub source code for details.
Logo
The PyCantonese logo is the Chinese character 粵 meaning Cantonese, with artistic design by albino.snowman (Instagram handle).
Acknowledgments
Wonderful resources with a permissive license that have been incorporated into PyCantonese:
HKCanCor
rime-cantonese
Individuals who have contributed feedback, bug reports, etc. (in alphabetical order of last names):
@cathug
Litong Chen
Jenny Chim
@g-traveller
Rachel Han
Ryan Lai
Charles Lam
Chaak Ming Lau
Hill Ma
@richielo
@rylanchiu
Stephan Stiller
Tsz-Him Tsui
Robin Yuen
Changelog
Please see CHANGELOG.md.
Setting up a Development Environment
The latest code under development is available on Github at jacksonllee/pycantonese. You need to have Git LFS installed on your system (run brew install git-lfs if you have Homebrew installed on MacOS, or run sudo apt-get install git-lfs if you’re on Ubuntu). To obtain this version for experimental features or for development:
$ git clone https://github.com/jacksonllee/pycantonese.git
$ cd pycantonese
$ git lfs pull
$ pip install -r dev-requirements.txt
$ pip install -e .
To run tests and styling checks:
$ pytest -vv --doctest-modules --cov=pycantonese pycantonese docs/source
$ flake8 pycantonese
$ black --check pycantonese
To build the documentation website files:
$ python docs/source/build_docs.py
Metadata
Release files for pycantonese 3.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pycantonese-3.4.0.tar.gz | 3.8 MB | Without provenance | Details for pycantonese-3.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pycantonese-3.4.0-py3-none-any.whl | Python 3 | none | any | Details for pycantonese-3.4.0-py3-none-any.whl |
Total release size: 7.7 MB
Release files / pycantonese-3.4.0.tar.gz
| Download URL | pycantonese-3.4.0.tar.gz |
|---|---|
| Size | 3.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c0768bbfbc9862b9a149525edfd24dc34f380d5d654fae3597da3f0951a0752
|
|
BLAKE2b-256 checksum How to use checksums |
44284b0cbc503f0be6dd4c55306d85643a785f64cd733778a79d472c779eb491
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
|
Release files / pycantonese-3.4.0-py3-none-any.whl
| Download URL | pycantonese-3.4.0-py3-none-any.whl |
|---|---|
| Size | 3.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2585ae8070cc6a3a32f1cf0fd395c93f10aa531272e5292c4d082215104d7958
|
|
BLAKE2b-256 checksum How to use checksums |
d1b8bb21891cc1cc0466d15e211896b614c73b494434b837e326008b501851c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
|
Security for pycantonese 3.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.