Skip to content

Commit f94b8df

Browse files
Prepare pip package configuration and order files
1 parent c4ae422 commit f94b8df

14 files changed

Lines changed: 38 additions & 7 deletions

File tree

MANIFEST.in

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include README.md
2+
include RELEASE.md
3+
include examples/*
4+
include docs/*
5+
include shexstatements/static/css/*
6+
include shexstatements/static/images/*
7+
include shexstatements/templates/*

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22
ShExStatements allows the users to generate shape expressions from simple CSV statements or files. `shexstatements` can be used from the command line as well as from the web interface.
33

44
## Quick start
5+
6+
### Using pip
7+
Set up a virtual environment and install `shexstatements`.
8+
9+
```
10+
$ python3 -m venv .venv
11+
$ source ./.venv/bin/activate
12+
$ pip3 install shexstatements
13+
```
14+
15+
Run the following command with an [example CSV file](https://github.com/johnsamuelwrites/ShExStatements/tree/master/examples/language.csv). The file contains an example description of a language on Wikidata. This file uses comma as a delimiter to separate the values.
16+
```
17+
$ shexstatements.sh examples/language.csv
18+
```
19+
20+
## Build from source
521
### Terminal
622
Clone the **ShExStatements** repository.
723
```
@@ -94,7 +110,7 @@ $ ./shexstatements.sh -ap --skipheader examples/languageap.csv
94110

95111

96112
## Documentation and examples
97-
A detailed documentation can be found [here](./docs/docs.md). with a number of example CSV files in the [examples](examples/) folder.
113+
A detailed documentation can be found [here](https://github.com/johnsamuelwrites/ShExStatements/tree/master/docs/docs.md). with a number of example CSV files in the [examples](https://github.com/johnsamuelwrites/ShExStatements/tree/master/examples) folder.
98114

99115
## Test cases and coverage
100116
All the test cases can be run in the following manner
@@ -135,7 +151,7 @@ $ ./shexstatements.sh -r
135151
Check the URL `http://127.0.0.1:5000/`
136152

137153
## API
138-
ShExStatements also has an API to generate ShEx from CSV and is described here [here](./docs/api.md).
154+
ShExStatements also has an API to generate ShEx from CSV and is described [here](https://github.com/johnsamuelwrites/ShExStatements/tree/master/docs/api.md).
139155

140156
## Demonstration
141157
Online demonstrations are also available:

RELEASE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
# v0.7 (in progress)
1+
# v0.8 (in progress)
22
===============================================================================
3-
*
3+
*
4+
5+
# v0.7
6+
===============================================================================
7+
* Support more than one input CSV files on the command line
8+
* Support option to run web application from the command line (`--run`)
9+
* Update documentation
10+
* Prepare `pip` first release
411

512
# v0.6
613
===============================================================================

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
url="https://github.com/johnsamuelwrites/ShExStatements",
2424
packages=setuptools.find_packages(),
2525
scripts=["shexstatements.sh"],
26+
include_package_data=True,
2627
classifiers=[
2728
"Programming Language :: Python :: 3",
2829
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",

shexstatements/application.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import json
44

55
app = Flask(__name__, static_url_path='',
6-
static_folder='../static',
7-
template_folder='../templates')
6+
static_folder='./static',
7+
template_folder='./templates')
88

99
@app.route('/', methods=['GET','POST'])
1010
def generateshex():
File renamed without changes.

0 commit comments

Comments
 (0)