Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/unify readme #186

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Feature/unify readme #186

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
194110d
chg: dev: rename to rst
rachmadaniHaryono Jun 28, 2018
3263efd
new: doc: text from setup.py
rachmadaniHaryono Jun 28, 2018
6a16ba1
chg: dev: format based on rst
rachmadaniHaryono Jun 28, 2018
9b76da4
chg: dev: use readme for long description
rachmadaniHaryono Jun 28, 2018
0fd741b
chg: dev: include readme in manifest
rachmadaniHaryono Jun 28, 2018
70748cf
new: dev: travis badge
rachmadaniHaryono Jun 28, 2018
9bf2eed
new: doc: pypi badge
rachmadaniHaryono Jun 28, 2018
b9e0565
chg: dev: use codecs for python 2 compatibility
rachmadaniHaryono Jun 29, 2018
8f9bac0
chg: dev: add suggestion
rachmadaniHaryono Jun 29, 2018
fb38859
chg: dev: projects urls
rachmadaniHaryono Jun 29, 2018
57be2a0
chg: doc: use global-option for pip 20.0
rachmadaniHaryono May 28, 2020
e5a27a4
chg: doc: for pip < 20.0
rachmadaniHaryono May 28, 2020
a68000c
new: doc: source code url
rachmadaniHaryono May 28, 2020
e841551
chg: doc: installation
rachmadaniHaryono May 28, 2020
596ca50
chg: doc: use https
rachmadaniHaryono May 28, 2020
897dc25
chg: doc: use https on readme
rachmadaniHaryono May 28, 2020
dd26747
Merge remote-tracking branch 'upstream/master' into feature/unify-readme
rachmadaniHaryono Nov 22, 2021
9e446ae
chg: doc: update to latest readme
rachmadaniHaryono Nov 23, 2021
c77af38
chg: doc: long_description_content_type
rachmadaniHaryono Nov 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chg: dev: format based on rst
  • Loading branch information
@rachmadaniHaryono
rachmadaniHaryono committed May 28, 2020
commit 6a16ba1f61e61e5aa73db357119b71d1399758cf
24 changes: 15 additions & 9 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,26 @@ supports standard YAML tags and provides Python-specific tags that
allow to represent an arbitrary Python object.

PyYAML is applicable for a broad range of tasks from complex
configuration files to object serialization and persistence."""
configuration files to object serialization and persistence.

To install, type 'python setup.py install'.
To install, type ``python setup.py install``.
rachmadaniHaryono marked this conversation as resolved.
Show resolved Hide resolved

By default, the setup.py script checks whether LibYAML is installed
and if so, builds and installs LibYAML bindings. To skip the check
and force installation of LibYAML bindings, use the option '--with-libyaml':
'python setup.py --with-libyaml install'. To disable the check and
skip building and installing LibYAML bindings, use '--without-libyaml':
'python setup.py --without-libyaml install'.
and force installation of LibYAML bindings, use the option ``--with-libyaml``:
``python setup.py --with-libyaml install``. To disable the check and
skip building and installing LibYAML bindings, use ``--without-libyaml``:


.. code-block:: shell

python setup.py --without-libyaml install
rachmadaniHaryono marked this conversation as resolved.
Show resolved Hide resolved

When LibYAML bindings are installed, you may use fast LibYAML-based
parser and emitter as follows:

.. code-block:: python

>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)

Expand All @@ -32,7 +38,7 @@ If you don't trust the input stream, you should use:
>>> yaml.safe_load(stream)

PyYAML includes a comprehensive test suite. To run the tests,
type 'python setup.py test'.
type ``python setup.py test``.

For more information, check the PyYAML homepage:
'https://github.com/yaml/pyyaml'.
Expand All @@ -41,7 +47,7 @@ For PyYAML tutorial and reference, see:
'http://pyyaml.org/wiki/PyYAMLDocumentation'.

Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net.

ZZ
rachmadaniHaryono marked this conversation as resolved.
Show resolved Hide resolved
You may also use the YAML-Core mailing list:
'http://lists.sourceforge.net/lists/listinfo/yaml-core'.

Expand All @@ -52,4 +58,4 @@ The PyYAML module was written by Kirill Simonov <xi@resolvent.net>.
It is currently maintained by the YAML and Python communities.

PyYAML is released under the MIT license.
See the file LICENSE for more details.
See the file LICENSE for more details.