Skip to content

Commit

Permalink
DEVOPS-210: Review for migration to twine. (#88)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
seth-mg authored Feb 11, 2019
1 parent b89c1da commit 8ce1423
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 41 deletions.
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
language: python
dist: xenial
# Reflect version changes in setup.py classifiers
# 2.7 EOL - January 2020
# 3.4 EOL - March 2019
# RCB-562 for 3.7 support
python:
- "2.7"
- "3.4"
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2014-2016 Basis Technology Corporation.
Copyright (c) 2014-2019 Basis Technology Corporation.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[![Build Status](https://travis-ci.org/rosette-api/python.svg?branch=develop)](https://travis-ci.org/rosette-api/python)
[![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)

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

### Installation

Expand Down Expand Up @@ -33,28 +34,27 @@ For help in how to call the various endpoints, please refer to the [examples](ht
- name translation
- ping
- relationships
- semantic similarity
- semantic vectors
- sentences
- sentiment
- syntax dependencies
- text embedding
- tokens
- topics
- transliteration

### API Documentation
See [documentation](http://rosette-api.github.io/python)

### Release Notes
See [wiki](https://github.com/rosette-api/python/wiki/Release-Notes)

### Docker
A Docker image for running the examples against the compiled source library is available on Docker Hub.

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

Additional environment settings:
`-e ALT_URL=<alternative URL>`
`-e FILENAME=<single filename>`

### API Documentation
See [documentation](http://rosette-api.github.io/python)

### Release Notes
See [wiki](https://github.com/rosette-api/python/wiki/Release-Notes)
- `-e ALT_URL=<alternative URL>`
- `-e FILENAME=<single filename>`

### Additional Information
Visit [Rosette API site](https://developer.rosette.com)
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

# General information about the project.
project = ''
copyright = '2017, Basis Technology'
copyright = '2019, Basis Technology'
author = 'Basis Technology'

# The version info for the project you're documenting, acts as replacement for
Expand Down
2 changes: 1 addition & 1 deletion rosette/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Python client for the Rosette API.
Copyright (c) 2014-2015 Basis Technology Corporation.
Copyright (c) 2014-2019 Basis Technology Corporation.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Expand Down
2 changes: 1 addition & 1 deletion rosette/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""
Python client for the Rosette API.
Copyright (c) 2014-2017 Basis Technology Corporation.
Copyright (c) 2014-2019 Basis Technology Corporation.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
52 changes: 30 additions & 22 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
NAME = "rosette_api"
DESCRIPTION = "Rosette API Python client SDK"
AUTHOR = "Basis Technology Corp."
AUTHOR_EMAIL = "rosette_api@basistech.com"
HOMEPAGE = "https://developer.rosette.com"
AUTHOR_EMAIL = "support@rosette.com"
HOMEPAGE = "https://github.com/rosette-api/python"
VERSION = rosette.__version__

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

LONG_DESCRIPTION = read('README.md')

setup(name=NAME,
author=AUTHOR,
author_email=AUTHOR_EMAIL,
description=DESCRIPTION,
license='Apache License',
long_description=LONG_DESCRIPTION,
packages=['rosette'],
install_requires=['requests'],
platforms='any',
url=HOMEPAGE,
version=VERSION,
classifiers=[
'Programming Language :: Python',
'Development Status :: 4 - Beta',
'Natural Language :: English',
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Operating System :: OS Independent',
'Topic :: Software Development :: Libraries :: Python Modules'])
setup(
name=NAME,
author=AUTHOR,
author_email=AUTHOR_EMAIL,
description=DESCRIPTION,
license='Apache License',
long_description=LONG_DESCRIPTION,
long_description_content_type='text/markdown',
packages=['rosette'],
install_requires=['requests'],
platforms='any',
url=HOMEPAGE,
version=VERSION,
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Topic :: Software Development :: Libraries :: Python Modules'
]
)
2 changes: 1 addition & 1 deletion tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-

"""
Copyright (c) 2014-2017 Basis Technology Corporation.
Copyright (c) 2014-2019 Basis Technology Corporation.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion tests/test_rosette_api.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-

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

0 comments on commit 8ce1423

Please sign in to comment.