Skip to content

Commit 378663d

Browse files
author
Alexandre Lissy
committed
Improve packages docs references and links
Fixes mozilla#1376
1 parent 1873ac6 commit 378663d

File tree

5 files changed

+30
-4
lines changed

5 files changed

+30
-4
lines changed

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.0-alpha.3
1+
0.2.0-alpha.4

native_client/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ bindings-clean:
3131
rm -f python/model_wrap.cpp python/utils_wrap.cpp python/model.py python/utils.py
3232

3333
bindings-build:
34-
pip install --quiet $(PYTHON_PACKAGES) wheel
34+
pip install --quiet $(PYTHON_PACKAGES) wheel==0.31.0 setuptools==39.1.0
3535
AS=$(AS) CC=$(CC) CXX=$(CXX) LD=$(LD) CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS_NEEDED) $(RPATH_PYTHON)" MODEL_LDFLAGS="$(LDFLAGS_DIRS)" UTILS_LDFLAGS="-L${TFDIR}/bazel-bin/native_client" MODEL_LIBS="$(LIBS)" $(PYTHON_PATH) $(NUMPY_INCLUDE) python ./setup.py build_ext $(PYTHON_PLATFORM_NAME)
3636

3737
MANIFEST.in: bindings-build

native_client/javascript/Makefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ include ../definitions.mk
99
default: build
1010

1111
clean:
12-
rm -f deepspeech_wrap.cxx package.json
12+
rm -f deepspeech_wrap.cxx package.json README.md
1313
rm -rf ./build/
1414

1515
clean-npm-pack:
@@ -19,6 +19,9 @@ clean-npm-pack:
1919
really-clean: clean clean-npm-pack
2020
rm -fr ./lib/
2121

22+
README.md:
23+
cp ../../README.md README.md
24+
2225
package.json: package.json.in
2326
sed \
2427
-e 's/$$(PROJECT_NAME)/$(PROJECT_NAME)/' \
@@ -37,7 +40,7 @@ copy-deps: build
3740
node-wrapper: copy-deps build
3841
$(NODE_BUILD_TOOL) $(NODE_PLATFORM_TARGET) $(NODE_ABI_TARGET) package $(NODE_BUILD_VERBOSE)
3942

40-
npm-pack: clean package.json
43+
npm-pack: clean package.json README.md
4144
npm install [email protected]
4245
npm pack $(NODE_BUILD_VERBOSE)
4346

native_client/javascript/package.json.in

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@
77
"deepspeech": "./client.js"
88
},
99
"author" : "Mozilla",
10+
"license": "MPL-2.0",
11+
"homepage": "https://github.com/mozilla/DeepSpeech/tree/$(PROJECT_VERSION)#project-deepspeech",
12+
"files": [
13+
"README.md",
14+
"client.js",
15+
"index.js",
16+
"lib/*"
17+
],
18+
"bugs": {
19+
"url": "https://github.com/mozilla/DeepSpeech/issues"
20+
},
1021
"repository" : {
1122
"type" : "git",
1223
"url" : "git://github.com/mozilla/DeepSpeech.git"

native_client/setup.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
numpy_include = ''
1818
assert 'NUMPY_INCLUDE' in os.environ
1919

20+
def read(fname):
21+
return open(os.path.join(os.path.dirname(__file__), fname)).read()
22+
2023
numpy_include = os.getenv('NUMPY_INCLUDE', numpy_include)
2124

2225
project_name = 'deepspeech'
@@ -49,13 +52,22 @@ class BuildExtFirst(build):
4952

5053
setup(name = project_name,
5154
description = 'A library for running inference on a DeepSpeech model',
55+
long_description = read('../README.md'),
56+
long_description_content_type = 'text/markdown; charset=UTF-8',
5257
author = 'Mozilla',
5358
version = project_version,
5459
package_dir = {'deepspeech': 'python'},
5560
packages = ['deepspeech'],
5661
cmdclass = {'build': BuildExtFirst},
5762
license = 'MPL-2.0',
5863
url = 'https://github.com/mozilla/DeepSpeech',
64+
project_urls = {
65+
'Documentation': 'https://github.com/mozilla/DeepSpeech/tree/{}#project-deepspeech'.format(project_version),
66+
'Tracker': 'https://github.com/mozilla/DeepSpeech/issues',
67+
'Repository': 'https://github.com/mozilla/DeepSpeech/tree/{}'.format(project_version),
68+
'Home': 'https://github.com/mozilla/DeepSpeech',
69+
'Discussions': 'https://discourse.mozilla.org/c/deep-speech',
70+
},
5971
ext_modules = [model, utils],
6072
entry_points={'console_scripts':['deepspeech = deepspeech.client:main']},
6173
install_requires = ['numpy', 'scipy'],

0 commit comments

Comments
 (0)