Maintenance will be performed on git.ligo.org, chat.ligo.org, containers.ligo.org, and docs.ligo.org on the morning of Tuesday 11th August 2020, starting at approximately 9am PDT. It is expected to take around 20 minutes and there will be a short period of downtime (less than five minutes) towards the end of the maintenance window. Please direct any comments, questions, or concerns to computing-help@ligo.org.

minor docs update

parent 3ba9fc0a
Contributing
============
To contribute to this package, fork the `repository <https://git.ligo.org/lscsoft/gracedb-client>`__, do development on a branch, and when it is ready, submit a merge request.
Basic workflow:
- Fork the `repository <https://git.ligo.org/lscsoft/gracedb-client>`__
- Develop on a branch
- Run tests
- Submit a `merge request <https://git.ligo.org/lscsoft/gracedb-client/merge_requests>`__
Setting up your environment
......@@ -10,7 +16,8 @@ Set up and activate a virtualenv::
virtualenv gracedb-client-dev
source gracedb-client-dev/bin/activate
Install the package in `development mode <https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode>`__ - from the root of the repository, do::
Install the package in `development mode <https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode>`__.
In the repository root, run::
python setup.py develop
......@@ -39,13 +46,18 @@ To help with this, you can install a pre-commit hook for linting with ``flake8``
flake8 --install-hook=git
git config --bool flake8.strict true
To do manual linting, you can do::
To run the linting process manually, you can do::
flake8 *.py ligo/
from the root of the repository.
Command-line client
~~~~~~~~~~~~~~~~~~~
If you add some useful, non-private functionality to the client class, something similar should probably be added to the command-line client, as well.
Running tests
-------------
This package includes a set of unit tests which cover much of the available functionality.
......@@ -72,7 +84,7 @@ As a result, there are two separate commands for running the integration tests::
Comprehensive testing
~~~~~~~~~~~~~~~~~~~~~
A `configuration <https://git.ligo.org/lscsoft/gracedb-client/blob/master/tox.ini>`__ is provided for using `tox <https://tox.readthedocs.io/>`__ to automate testing with different versions of Python.
This package includes a `configuration <https://git.ligo.org/lscsoft/gracedb-client/blob/master/tox.ini>`__ for using `tox <https://tox.readthedocs.io/>`__ to automate testing with different versions of Python.
The current configuration uses Python 2.7 and Python 3.4-3.7, if available on your system.
``tox`` should already be installed from the ``requirements-dev.txt`` file.
......
......@@ -41,7 +41,7 @@ If you have long-running jobs where the lifetime of a client may exceed that of
use the ``reload_certificate`` argument (and optionally, the ``reload_buffer`` argument) when instantiating a client object.
On each request, the client will check whether your certificate has expired; if it has, the client will attempt to reload the certificate before sending the request to the server.
**NOTE:** the client requires that your renewed certificate is in the same location as the old one.
**NOTES:** the client requires that your renewed certificate is in the same location as the old one.
Users may want to set up a cron job to facilitate auto-renewal of their certificate.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment