README.rst 955 Bytes
Newer Older
root's avatar
root committed
1
2
3
4
5
README for yams
===============

Distributions
-------------
Julien Cristau's avatar
Julien Cristau committed
6
The source tarball is available at https://pypi.python.org/pypi/yams
root's avatar
root committed
7
8
9
10
11
12
13
14
15
16
17
18
19

Install
-------
From the source distribution, extract the tarball and run ::

    python setup.py install

For debian and rpm packages, use your usual tools according to your Linux
distribution. 


Documentation
-------------
20
21

The documentation is available at https://yams.readthedocs.io/
root's avatar
root committed
22
23


24
25
26
27
28
29
30
31
32
33
34
35
Code style
----------

The python code is verified against *flake8* and formatted with *black*.

* You can run `tox -e black` to check that the files are well formatted.
* You can run `tox -e black-run` to format them if needed.
* You can include the `.hgrc` to your own `.hgrc` to automatically run black
  before each commit/amend. This can be done by writing `%include ../.hgrc` at
  the end of your `.hgrc`.


root's avatar
root committed
36
37
Comments, support, bug reports
------------------------------
Julien Cristau's avatar
Julien Cristau committed
38
See the tracker at https://www.logilab.org/project/yams