Skip to content

Commit 8ce1423

Browse files
authored
DEVOPS-210: Review for migration to twine. (#88)
* Tell PyPi we're using markdown for rendering. * An email address that works. * Github as homepage. * Move developer.rosette.com references to the top of the README. * The package is stable. * semantics endpoints in README. * PyPi badge. * Bump travis to xenial * Issue id for Python 3.7 support * Copyright years
1 parent b89c1da commit 8ce1423

File tree

9 files changed

+54
-41
lines changed

9 files changed

+54
-41
lines changed

.travis.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
language: python
2+
dist: xenial
3+
# Reflect version changes in setup.py classifiers
4+
# 2.7 EOL - January 2020
5+
# 3.4 EOL - March 2019
6+
# RCB-562 for 3.7 support
27
python:
38
- "2.7"
49
- "3.4"

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2014-2016 Basis Technology Corporation.
1+
Copyright (c) 2014-2019 Basis Technology Corporation.
22

33
Licensed under the Apache License, Version 2.0 (the "License");
44
you may not use this file except in compliance with the License.

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
[![Build Status](https://travis-ci.org/rosette-api/python.svg?branch=develop)](https://travis-ci.org/rosette-api/python)
1+
[![Build Status](https://travis-ci.org/rosette-api/python.svg?branch=develop)](https://travis-ci.org/rosette-api/python) [![PyPI version](https://badge.fury.io/py/rosette_api.svg)](https://badge.fury.io/py/rosette_api)
22

33
## This is the Python client binding for Rosette API.
4-
Please check out the [wiki](https://github.com/rosette-api/python/wiki) for additional information
4+
You can get an API Key and learn more [here](https://developer.rosette.com).
5+
For more detailed information check out our [features and functions page](https://developer.rosette.com/features-and-functions).
56

67
### Installation
78

@@ -33,28 +34,27 @@ For help in how to call the various endpoints, please refer to the [examples](ht
3334
- name translation
3435
- ping
3536
- relationships
37+
- semantic similarity
38+
- semantic vectors
3639
- sentences
3740
- sentiment
3841
- syntax dependencies
39-
- text embedding
4042
- tokens
4143
- topics
4244
- transliteration
4345

46+
### API Documentation
47+
See [documentation](http://rosette-api.github.io/python)
48+
49+
### Release Notes
50+
See [wiki](https://github.com/rosette-api/python/wiki/Release-Notes)
51+
4452
### Docker
4553
A Docker image for running the examples against the compiled source library is available on Docker Hub.
4654

4755
Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-python`
4856

4957
Additional environment settings:
50-
`-e ALT_URL=<alternative URL>`
51-
`-e FILENAME=<single filename>`
52-
53-
### API Documentation
54-
See [documentation](http://rosette-api.github.io/python)
55-
56-
### Release Notes
57-
See [wiki](https://github.com/rosette-api/python/wiki/Release-Notes)
58+
- `-e ALT_URL=<alternative URL>`
59+
- `-e FILENAME=<single filename>`
5860

59-
### Additional Information
60-
Visit [Rosette API site](https://developer.rosette.com)

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747

4848
# General information about the project.
4949
project = ''
50-
copyright = '2017, Basis Technology'
50+
copyright = '2019, Basis Technology'
5151
author = 'Basis Technology'
5252

5353
# The version info for the project you're documenting, acts as replacement for

rosette/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
Python client for the Rosette API.
3-
Copyright (c) 2014-2015 Basis Technology Corporation.
3+
Copyright (c) 2014-2019 Basis Technology Corporation.
44
Licensed under the Apache License, Version 2.0 (the "License");
55
you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at

rosette/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44
Python client for the Rosette API.
55
6-
Copyright (c) 2014-2017 Basis Technology Corporation.
6+
Copyright (c) 2014-2019 Basis Technology Corporation.
77
88
Licensed under the Apache License, Version 2.0 (the "License");
99
you may not use this file except in compliance with the License.

setup.py

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
NAME = "rosette_api"
99
DESCRIPTION = "Rosette API Python client SDK"
1010
AUTHOR = "Basis Technology Corp."
11-
AUTHOR_EMAIL = "rosette_api@basistech.com"
12-
HOMEPAGE = "https://developer.rosette.com"
11+
AUTHOR_EMAIL = "support@rosette.com"
12+
HOMEPAGE = "https://github.com/rosette-api/python"
1313
VERSION = rosette.__version__
1414

1515
HERE = os.path.abspath(os.path.dirname(__file__))
@@ -28,23 +28,31 @@ def read(*filenames, **kwargs):
2828

2929
LONG_DESCRIPTION = read('README.md')
3030

31-
setup(name=NAME,
32-
author=AUTHOR,
33-
author_email=AUTHOR_EMAIL,
34-
description=DESCRIPTION,
35-
license='Apache License',
36-
long_description=LONG_DESCRIPTION,
37-
packages=['rosette'],
38-
install_requires=['requests'],
39-
platforms='any',
40-
url=HOMEPAGE,
41-
version=VERSION,
42-
classifiers=[
43-
'Programming Language :: Python',
44-
'Development Status :: 4 - Beta',
45-
'Natural Language :: English',
46-
'Environment :: Web Environment',
47-
'Intended Audience :: Developers',
48-
'License :: OSI Approved :: Apache Software License',
49-
'Operating System :: OS Independent',
50-
'Topic :: Software Development :: Libraries :: Python Modules'])
31+
setup(
32+
name=NAME,
33+
author=AUTHOR,
34+
author_email=AUTHOR_EMAIL,
35+
description=DESCRIPTION,
36+
license='Apache License',
37+
long_description=LONG_DESCRIPTION,
38+
long_description_content_type='text/markdown',
39+
packages=['rosette'],
40+
install_requires=['requests'],
41+
platforms='any',
42+
url=HOMEPAGE,
43+
version=VERSION,
44+
classifiers=[
45+
'Development Status :: 5 - Production/Stable',
46+
'Environment :: Web Environment',
47+
'Intended Audience :: Developers',
48+
'License :: OSI Approved :: Apache Software License',
49+
'Natural Language :: English',
50+
'Operating System :: OS Independent',
51+
'Programming Language :: Python',
52+
'Programming Language :: Python :: 2.7',
53+
'Programming Language :: Python :: 3.4',
54+
'Programming Language :: Python :: 3.5',
55+
'Programming Language :: Python :: 3.6',
56+
'Topic :: Software Development :: Libraries :: Python Modules'
57+
]
58+
)

tests/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22

33
"""
4-
Copyright (c) 2014-2017 Basis Technology Corporation.
4+
Copyright (c) 2014-2019 Basis Technology Corporation.
55
66
Licensed under the Apache License, Version 2.0 (the "License");
77
you may not use this file except in compliance with the License.

tests/test_rosette_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22

33
"""
4-
Copyright (c) 2014-2017 Basis Technology Corporation.
4+
Copyright (c) 2014-2019 Basis Technology Corporation.
55
66
Licensed under the Apache License, Version 2.0 (the "License");
77
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)