Merge pull request #29 from nlesc-nano/dev

Preparing for release 1.0
nlesc-nano · Mar 22, 2021 · ccda1e7 · ccda1e7
2 parents 1dc535f + 2841bf4
commit ccda1e7
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 13 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,12 @@
 Change Log
 ##########
 
+1.0.0 [22/03/2021]
+******************
+New
+---
+* Make the client generic to uses other that quantum chemistry
+
 
 0.3.0 [22/02/2021]
 ******************

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -34,7 +34,7 @@ You want to make some kind of change to the code base
 
 #. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
 #. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
-#. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here <https://help.github.com/articles/configuring-a-remote-for-a-fork/>`__ and `here <https://help.github.com/articles/syncing-a-fork/>`__);
+#. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here <https://help.github.com/articles/configuring-a-remote-for-a-fork/>`__ and `here <https://help.github.com/articles/syncing-a-fork/>`__);
 #. make sure the existing tests still work by running ``python setup.py test``;
 #. add your own tests (if necessary);
 #. update or expand the documentation;

diff --git a/README.rst b/README.rst
@@ -2,7 +2,7 @@
    :target: https://github.com/nlesc-nano/ceiba-cli/actions
 .. image:: https://readthedocs.org/projects/ceiba-cli/badge/?version=latest
    :target: https://ceiba-cli.readthedocs.io/en/latest/?badge=latest
-.. image:: https://codecov.io/gh/nlesc-nano/ceiba-cli/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/nlesc-nano/ceiba-cli/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/nlesc-nano/ceiba-cli
 .. image:: https://zenodo.org/badge/296641388.svg
    :target: https://zenodo.org/badge/latestdoi/296641388
@@ -12,7 +12,7 @@ ceiba-cli
 #########
 
 command line interface to interact with the `insilico web server <https://github.com/nlesc-nano/ceiba>`_.
-See the `documentation <https://ceiba-cli-command-line-interface.readthedocs.io/en/latest/>`_.
+See the `documentation <https://ceiba-cli-command-line-interface.readthedocs.io/en/latest/>`_ and `blog post <https://blog.esciencecenter.nl/building-a-web-service-to-manage-scientific-simulation-data-using-graphql-a0bbf1c3f6e9>`_.
 
 
 Installation
@@ -22,7 +22,7 @@ To install ceiba-cli, do:
 
 .. code-block:: console
 
-  pip install git+https://github.com/nlesc-nano/ceiba-cli.git@master
+  pip install git+https://github.com/nlesc-nano/ceiba-cli.git@main
 
 Contributing
 ############

diff --git a/ceibacli/__version__.py b/ceibacli/__version__.py
@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "1.0.0"
diff --git a/docs/authentication.rst b/docs/authentication.rst
@@ -8,7 +8,7 @@ For doing so, you should:
 
 1. Go to `github tokens <https://github.com/settings/tokens>`_ and click the ``Generate new token`` button.
 2. Provide your GitHub password when prompted
-3. Fill in a description for the token, for example, *insilico access token*.
+3. Fill in a description for the token, for example, *ceiba access token*.
 4. **Do not enable any scope** therefore the token will grant read-only access to the app
 5. Click ``Generate`` at the bottom. Make sure to copy its value because you will need it to login!
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,8 +43,8 @@
 # source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
-# The master toctree document.
-master_doc = 'index'
+# The main toctree document.
+main_doc = 'index'
 
 # General information about the project.
 project = u'ceibacli'
@@ -149,7 +149,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ceibacli.tex', u'ceibacli Documentation',
+    (main_doc, 'ceibacli.tex', u'ceibacli Documentation',
      u"Felipe Zapata", 'manual'),
 ]
 
@@ -159,7 +159,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'ceibacli', u'ceibacli Documentation',
+    (main_doc, 'ceibacli', u'ceibacli Documentation',
      [author], 1)
 ]
 
@@ -170,7 +170,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ceibacli', u'ceibacli Documentation',
+    (main_doc, 'ceibacli', u'ceibacli Documentation',
      author, 'ceibacli', "command line interface to compute molecular properties",
      'Miscellaneous'),
 ]
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-.. ceibacli documentation master file, created by
+.. ceibacli documentation main file, created by
    sphinx-quickstart on Thu Jun 21 11:07:11 2018.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -1,7 +1,7 @@
 Usage
 #####
 The **ceibacli** command line interface offers four actions to interact
-with the `insilico web service <https://github.com/nlesc-nano/insilico-server>`_.
+with the `Ceiba web service <https://github.com/nlesc-nano/ceiba>`_.
 You can check them by trying the following command in your terminal:
 ::