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

Jump to bottom

Update README with chat info #1363

Merged
merged 4 commits into from
Jul 17, 2021
Merged

Update README with chat info #1363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5265251
reorganize README sections
white-gecko Jul 16, 2021
c63abb3
add info about chat to README. #1341.
white-gecko Jul 16, 2021
8607dcb
whitespace changes
white-gecko Jul 16, 2021
bc11bea
update docs
white-gecko Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
63 changes: 27 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@ Please see the list for all packages/repositories here:

* <https://github.com/RDFLib>


## Versions
## Versions & Releases

* `5.x.y` supports Python 2.7 and 3.4+ and is [mostly backwards compatible with 4.2.2](https://rdflib.readthedocs.io/en/stable/upgrade4to5.html). Only bug fixes will be applied.
* `6.x.y` is the next major release which will support Python 3.6+. (Current master branch)

See <https://rdflib.dev> for the release schedule.

## Documentation
See <https://rdflib.readthedocs.io> for our documentation built from the code.

## Installation
RDFLib may be installed with Python's package management tool *pip*:
Expand Down Expand Up @@ -102,8 +105,8 @@ g.add((
rdflib.Literal("Nick", datatype=XSD.string)
))
```
The triple (in n-triples notation) `<http://example.com/person/nick> <http://xmlns.com/foaf/0.1/givenName> "Nick"^^<http://www.w3.org/2001/XMLSchema#string> .`
is created where the property `FOAF.giveName` is the URI `<http://xmlns.com/foaf/0.1/givenName>` and `XSD.string` is the
The triple (in n-triples notation) `<http://example.com/person/nick> <http://xmlns.com/foaf/0.1/givenName> "Nick"^^<http://www.w3.org/2001/XMLSchema#string> .`
is created where the property `FOAF.giveName` is the URI `<http://xmlns.com/foaf/0.1/givenName>` and `XSD.string` is the
URI `<http://www.w3.org/2001/XMLSchema#string>`.

You can bind namespaces to prefixes to shorten the URIs for RDF/XML, Turtle, N3, TriG, TriX & JSON-LD serializations:
Expand Down Expand Up @@ -153,35 +156,6 @@ are listed on [PyPI](https://pypi.python.org/pypi/rdflib/)

Multiple other projects are contained within the RDFlib "family", see <https://github.com/RDFLib/>.


## Documentation
See <https://rdflib.readthedocs.io> for our documentation built from the code.


## Support
For general "how do I..." queries, please use https://stackoverflow.com and tag your question with `rdflib`.
Existing questions:

* <https://stackoverflow.com/questions/tagged/rdflib>


## Releases
See <https://rdflib.dev> for the release schedule.


## Contributing

RDFLib survives and grows via user contributions!
Please read our [contributing guide](https://rdflib.readthedocs.io/en/stable/developers.html) to get started.
Please consider lodging Pull Requests here:

* <https://github.com/RDFLib/rdflib/pulls>

You can also raise issues here:

* <https://github.com/RDFLib/rdflib/issues>


## Running tests

### Running the tests on the host
Expand Down Expand Up @@ -221,8 +195,25 @@ Once tests have produced HTML output of the coverage report, view it by running:
python -m http.server --directory=cover
```

## Contributing

RDFLib survives and grows via user contributions!
Please read our [contributing guide](https://rdflib.readthedocs.io/en/stable/developers.html) to get started.
Please consider lodging Pull Requests here:

* <https://github.com/RDFLib/rdflib/pulls>

You can also raise issues here:

* <https://github.com/RDFLib/rdflib/issues>

## Support & Contacts
For general "how do I..." queries, please use https://stackoverflow.com and tag your question with `rdflib`.
Existing questions:

* <https://stackoverflow.com/questions/tagged/rdflib>

## Contacts
If you want to contact the rdflib maintainers, please do so via the rdflib-dev mailing list:
If you want to contact the rdflib maintainers, please do so via:

* <https://groups.google.com/group/rdflib-dev>
* the rdflib-dev mailing list: <https://groups.google.com/group/rdflib-dev>
* the chat, which is available at [gitter](https://gitter.im/RDFLib/rdflib) or via matrix [#RDFLib_rdflib:gitter.im](https://matrix.to/#/#RDFLib_rdflib:gitter.im)
6 changes: 2 additions & 4 deletions docs/developers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Please be as Pythonic as possible (:pep:`8`).

Code should be formatted using `black <https://github.com/psf/black>`_.
While not yet mandatory, it will be required in the future (6.0.0+).1
Use Black v21.6b1, with the black.toml config file provided.
Use Black v21.6b1, with the black.toml config file provided.

Any new functionality being added to RDFLib should have doc tests and
unit tests. Tests should be added for any functionality being changed
Expand Down Expand Up @@ -110,6 +110,4 @@ No matter how you create the release tag, remember to upload tarball to pypi wit

Set new dev version number in the above locations, i.e. next release `-dev`: ``5.0.1-dev`` and commit again.

Tweet, email mailing list and update the topic of #rdflib on freenode irc::

/msg ChanServ topic #rdflib https://github.com/RDFLib/rdflib | latest stable version: 5.0.0 | docs: http://rdflib.readthedocs.org
Tweet, email mailing list and inform members in the chat.
22 changes: 12 additions & 10 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. rdflib documentation documentation master file

================
rdflib |release|
================
Expand Down Expand Up @@ -55,7 +55,7 @@ If you are familiar with RDF and are looking for details on how RDFLib handles i
merging
upgrade5to6
upgrade4to5


Reference
---------
Expand All @@ -68,9 +68,9 @@ API reference:

apidocs/modules

.. toctree::
.. toctree::
:maxdepth: 2

plugins

.. * :ref:`genindex`
Expand All @@ -86,9 +86,6 @@ For developers
docs
persisting_n3_terms

Developers might also like to join rdflib's dev mailing list: `<https://groups.google.com/group/rdflib-dev>`__


Source Code
-----------
The rdflib source code is hosted on GitHub at `<https://github.com/RDFLib/rdflib>`__ where you can lodge Issues and
Expand All @@ -98,15 +95,20 @@ The RDFlib organisation on GitHub at `<https://github.com/RDFLib>`__ maintains t
and RDFlib-related packaged that you might also find useful.


Further help
------------
For asynchronous chat support, try our gitter channel at `<https://gitter.im/RDFLib/rdflib>`__
Further help & Contact
----------------------

If you would like more help with using rdflib, rather than developing it, please post a question on StackOverflow using
the tag ``[rdflib]``. A list of existing ``[rdflib]`` tagged questions is kept there at:

* `<https://stackoverflow.com/questions/tagged/rdflib>`__

You might also like to join rdflib's dev mailing list: `<https://groups.google.com/group/rdflib-dev>`__

The chat is available at `gitter <https://gitter.im/RDFLib/rdflib>`_ or via matrix `#RDFLib_rdflib:gitter.im <https://matrix.to/#/#RDFLib_rdflib:gitter.im>`_.



Glossary
--------

Expand Down