README.md
1# Abseil Python Common Libraries
2
3This repository is a collection of Python library code for building Python
4applications. The code is collected from Google's own Python code base, and has
5been extensively tested and used in production.
6
7## Features
8
9* Simple application startup
10* Distributed commandline flags system
11* Custom logging module with additional features
12* Testing utilities
13
14## Getting Started
15
16### Installation
17
18To install the package, simply run:
19
20```bash
21pip install absl-py
22```
23
24Or install from source:
25
26```bash
27python setup.py install
28```
29
30### Running Tests
31
32To run Abseil tests, you can clone the git repo and run
33[bazel](https://bazel.build/):
34
35```bash
36git clone https://github.com/abseil/abseil-py.git
37cd abseil-py
38bazel test absl/...
39```
40
41### Example Code
42
43Please refer to [smoke_tests/sample_app.py](smoke_tests/sample_app.py) as an
44example to get started.
45
46## Documentation
47
48Full documentation is forthcoming on https://abseil.io. For now, please refer
49to the in-code Python docstrings.
50
51## Future Releases
52
53The current repository includes an initial set of libraries for early adoption.
54More components and interoperability with Abseil C++ Common Libraries
55will come in future releases.
56
57## License
58
59The Abseil Python library is licensed under the terms of the Apache
60license. See [LICENSE](LICENSE) for more information.
61