Skip to content

Commit 335a7ba

Browse files
johnpericoavilchess
authored andcommitted
Fix/readme (#39)
* feat(readme): Update set up requisites * Change shapelets url to the repository * Exclude all but .py files from codecov * Refine the readme
1 parent 6ab405f commit 335a7ba

3 files changed

Lines changed: 25 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,37 @@ This is the Khiva Python binding, it allows the usage of Khiva library from Pyth
1414
This project is licensed under [MPL-v2](https://www.mozilla.org/en-US/MPL/2.0/).
1515

1616
## Quick Summary
17-
This Python library called 'khiva' provides all the functionalities of the KHIVA library for time series analytics.
17+
This Python binding called 'khiva' provides all the functionalities of the KHIVA library for time series analytics.
1818

1919
## Set up
20-
It is just needed to execute the next command in the root directory of the project:
20+
In order to use this binding, you need to install Khiva library.
21+
22+
### Prerequisites
23+
- [Python 64-bits](https://www.python.org/downloads/)
24+
25+
> Note: By now, only 64-bit Python versions are supported.
26+
27+
> Note **Windows' users**: Search your 64-bits version [here](https://www.python.org/downloads/windows/)
28+
29+
### Install latest version
30+
Install latest stable version of Khiva library. Follow the steps in the "Installation" section of the [Khiva repository](https://github.com/shapelets/khiva)
31+
32+
To install the Khiva Python binding, we just need to execute the following command:
2133
```bash
2234
python setup.py install
2335
```
24-
> Note: By now, only 64-bit Python versions are supported.
36+
37+
### Install any release
38+
Install the prerequisites listed in the "Installation" section of the [Khiva library repository](https://github.com/shapelets/khiva). Download and install your selected Khiva release from [Khiva repository](https://github.com/shapelets/khiva/releases).
39+
40+
Install the Khiva python binding compatible with the Khiva library installed previously. Follow the steps to install the Khiva python binding explained in [pypi](https://pypi.org/project/khiva/).
41+
2542

2643
## Executing the tests:
27-
The tests can be executed and they are located in <project-root-dir>/tests/unit_tests.
44+
All tests can be executed separately, please find them in <project-root-dir>/tests/unit_tests.
2845

2946
## Documentation
30-
This Python library follows the standard way of writing documentation of Python by using Sphinx.
47+
This Khiva Python binding follows the standard way of writing documentation of Python by using Sphinx.
3148

3249
In order to generate the documentation (in html format), run the following command under the <project-root-dir>/docs folder:
3350
```bash

codecov.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
ignore:
2-
- "tests/"
2+
- "tests/"
3+
- ".*(?<!\.py)$"

docs/text/quick_start.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Install Khiva
99

1010
First of all, the Khiva C++ library should be installed:
1111

12-
`Shapelets <http://shapelets.io>`__.
12+
`Shapelets <https://github.com/shapelets/khiva>`__.
1313

1414

1515
Then, install the compiled Khiva package that is hosted on the Python Package Index (PyPI) with pip:

0 commit comments

Comments
 (0)