Skip to content

Commit f6f4233

Browse files
committed
Setting the repo name to GEMD-python; deploy docs on tags
1 parent 9b37723 commit f6f4233

File tree

6 files changed

+19
-15
lines changed

6 files changed

+19
-15
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ deploy:
2121
keep_history: true
2222
local_dir: "./docs/_build/html/"
2323
on:
24-
branch: master
24+
tags: true
2525
- provider: pypi
2626
user: "CitrineInformatics"
2727
password: "$PYPI_PASSWORD"

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ This package provides a framework for storing information about the processes th
66
## Usage
77

88
To install `gemd`, you can simply:
9-
```
9+
```bash
1010
$ pip install gemd
1111
```
1212

1313
Detailed documentation of the `GEMD` data model can be found in the [language-agnostic documentation](https://citrineinformatics.github.io/gemd-docs/).
14-
Documentation of this package can be found [here](https://citrineinformatics.github.io/gemd/).
14+
Documentation of this package can be found [here](https://citrineinformatics.github.io/gemd-python/).
1515

1616
## Developer instructions
1717
To download the repo and install requirements, run
1818

19-
```pip install git+https://github.com/CitrineInformatics/gemd-python.git```
19+
```bash
20+
pip install git+https://github.com/CitrineInformatics/gemd-python.git
21+
```
2022

2123
Tests are run with `pytest`, and the `pytest-cov` package is used to assess test coverage.
2224
In order to assess coverage locally, run `pytest` with the following arguments:
@@ -27,6 +29,8 @@ In order to assess coverage locally, run `pytest` with the following arguments:
2729
* `--cov-fail-under=100` Throws an error if coverage is less than 100% (optional)
2830

2931
The following command will run all tests, print line numbers for lines that are not executed, skip modules with full coverage, and fail if coverage is less than 100%:
30-
`python -m pytest --cov=gemd/ --cov-report term:skip-covered --cov-report term-missing --cov-fail-under=100`
32+
```bash
33+
pytest --cov=gemd --cov-report term-missing --cov-report term:skip-covered --cov-config=tox.ini --cov-fail-under=100 -s ./gemd
34+
```
3135

3236

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# -- Project information -----------------------------------------------------
1919

20-
project = 'GEMD'
20+
project = 'GEMD-python'
2121
copyright = '2020, Citrine Informatics'
2222
author = 'Citrine Informatics'
2323

docs/source/depth/unit_parsing.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Unit Parsing
44

55
Unit parsing is performed using the Pint_ package.
66
By default, Pint supports a larger set of units than the Citrine Platform.
7-
Therefore, we include a custom unit definition file in GEMD: `citrine_en.txt`_.
7+
Therefore, we include a custom unit definition file in GEMD-python: `citrine_en.txt`_.
88
This file contains the most commonly used units and will grow over time.
99

10-
Requests for support of additional units can be made by opening an issue in the `GEMD repository`_ on github.
10+
Requests for support of additional units can be made by opening an issue in the `GEMD-python repository`_ on github.
1111

1212
.. _Pint: https://pint.readthedocs.io/en/0.9/
13-
.. _citrine_en.txt: https://github.com/CitrineInformatics/gemd/blob/master/gemd/units/citrine_en.txt
14-
.. _GEMD repository: https://github.com/CitrineInformatics/gemd
13+
.. _citrine_en.txt: https://github.com/CitrineInformatics/gemd-python/blob/master/gemd/units/citrine_en.txt
14+
.. _GEMD-python repository: https://github.com/CitrineInformatics/gemd-python

docs/source/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to the GEMD Documentation!
6+
Welcome to the GEMD-Python Documentation!
77
===================================================
88

9-
GEMD is the Python implementation of the Citrine data model, the full documentation of which
9+
``gemd`` is the Python implementation of the Citrine data model, the full documentation of which
1010
can be found `here <https://citrineinformatics.github.io/gemd-docs/>`_.
1111

1212
To learn about the details of specific classes, please see the module index.

setup.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ def run(self):
3636

3737

3838
setup(name='gemd',
39-
version='0.6.1',
40-
url='http://github.com/CitrineInformatics/gemd',
41-
description='Python library for the Citrine Platform',
39+
version='0.6.2',
40+
url='http://github.com/CitrineInformatics/gemd-python',
41+
description="Python binding for Citrine's GEMD data model",
4242
author='Max Hutchinson',
4343
author_email='[email protected]',
4444
packages=find_packages(),

0 commit comments

Comments
 (0)