Skip to content

Commit

Permalink
Renaming package
Browse files Browse the repository at this point in the history
  • Loading branch information
animator committed Nov 21, 2019
1 parent 8f1b435 commit 4d1acf5
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

build/*
dist/*
titus.egg-info/*
titus2.egg-info/*
*.pyc
*.py.bak
.eggs/*
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
**v1.0.1:**

* Package renamed as titus2

* Now available in PyPI - `pip install titus2`

**v1.0.0:**

* Continues development on Titus v0.8.4 which was maintained by Open Data Group.
Expand Down
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Build Status](https://travis-ci.org/animator/python3-titus.svg?branch=master)](https://travis-ci.org/animator/python3-titus)
[![Build Status](https://travis-ci.org/animator/titus2.svg?branch=master)](https://travis-ci.org/animator/titus2)
[![](https://img.shields.io/badge/python-3.4%20|%203.5%20|%203.6%20|%203.7%20|%203.8-blue.svg)](https://www.python.org/download/)
![Maintenance](https://img.shields.io/maintenance/yes/2019)
![GitHub](https://img.shields.io/github/license/animator/python3-titus)
![GitHub](https://img.shields.io/github/license/animator/titus2)
![Twitter Follow](https://img.shields.io/twitter/follow/ankitmahato?label=Follow&style=social)

> **Data Scientist**: Why is my cutting edge model still not in production?
Expand All @@ -10,22 +10,21 @@ Scenario 1:
> **IT Team**: We are still implementing the scoring engine in Go/Java/C++.
Scenario 2:
> **IT Team**: We are still figuring out how to read the model.pkl file you provided in Java.
> **IT Team**: We are still figuring out how to read the model.pkl file you provided.
. .

and the push to production pang continues ..

# New Features!

- Supports Python 3.4+
- `scripts/pfachain` can combine 2 or more PFA documents
- Now available in PyPI - `pip install titus2`

### Changes in titus v1.0.0
### Changes in titus2 v1.0.1

View the complete changelog [here](https://github.com/animator/python3-titus/blob/master/CHANGELOG.md).
View the complete changelog [here](https://github.com/animator/titus2/blob/master/CHANGELOG.md).

Titus for Python 3.4+ - Portable Format for Analytics (PFA) implementation
Titus 2 - Portable Format for Analytics (PFA) implementation for Python 3.4+
========


Expand All @@ -35,11 +34,11 @@ The [Portable Format for Analytics (PFA)](http://dmg.org/pfa) is a specification

![PFA](http://dmg.org/pfa/docs/motivation/pfatoeverything.png)

**Titus** (Python 2) ([API](http://opendatagroup.github.io/hadrian/titus-0.8.3/titus.genpy.PFAEngine)) was originally Open Data's complete implementation of PFA for Python. It can be used for model development as well as to execute the scoring engine.
**Titus** (Python 2) ([API](http://opendatagroup.github.io/hadrian/titus-0.8.3/titus.genpy.PFAEngine)) was originally Open Data's complete implementation of PFA for Python. It can be used for model development as well as to execute the scoring engine. Titus 2 is a fork of Titus which is actively being maintained.

### Requirements

Titus uses a number of open source projects to work properly:
Titus 2 uses a number of open source projects to work properly:

* avro-python3
* numpy
Expand All @@ -54,7 +53,12 @@ The above packages are available via `pip` and are automatically installed durin
Titus requires [Python 3.4+](https://www.python.org/download/) to run.
It can be installed via pip/pip3 as follows:
```sh
$ pip install git+https://github.com/animator/python3-titus.git
$ pip install titus2
```

or you can directly install the latest build from github repository via
```sh
$ pip install git+https://github.com/animator/titus2.git
```

After installation please run the following elementary example in python
Expand All @@ -80,18 +84,18 @@ for num in l:
See the [Hadrian wiki](https://github.com/opendatagroup/hadrian/wiki) for user guide and tutorials.

### Current Testing Framework
- Unit testing status available [here](https://travis-ci.org/animator/python3-titus) [![Build Status](https://travis-ci.org/animator/python3-titus.svg?branch=master)](https://travis-ci.org/animator/python3-titus)
- Unit testing status available [here](https://travis-ci.org/animator/titus2) [![Build Status](https://travis-ci.org/animator/titus2.svg?branch=master)](https://travis-ci.org/animator/titus2)
- Conformance testing status available [here](https://travis-ci.org/animator/pfa) [![Build Status](https://travis-ci.org/animator/pfa.svg?branch=master)](https://travis-ci.org/animator/pfa)

### Issues and Feature Requests

Please raise an issue [here](https://github.com/animator/python3-titus/issues).
Please raise an issue [here](https://github.com/animator/titus2/issues).

### Development

Want to contribute? Great!

Please raise an [issue](https://github.com/animator/python3-titus/issues) and send a [pull request](https://github.com/animator/python3-titus/pulls).
Please raise an [issue](https://github.com/animator/titus2/issues) and send a [pull request](https://github.com/animator/titus2/pulls).

### Todos

Expand Down
39 changes: 33 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from os import path, walk
from setuptools import setup

import titus.version
Expand All @@ -29,11 +29,13 @@

### To install in a home directory (~/lib):
# python setup.py install --home=~
LONG_DESCRIPTION = open(path.join(path.dirname(__file__), 'README.md')).read()

setup(name="titus",
setup(name="titus2",
version=titus.version.__version__,
author="Ankit Mahato",
author_email="ankmahato@gmail.com",
keywords='pfa scoring inference pmml titus hadrian machine learning data mining',
packages=["titus",
"titus.producer",
"titus.lib",
Expand All @@ -44,18 +46,43 @@
"titus.inspector"],
scripts = ["scripts/pfainspector", "scripts/pfachain", "scripts/pfaexternalize", "scripts/pfarandom", "scripts/pfasize"],
description="Python 3 implementation of Portable Format for Analytics (PFA): producer, converter, and consumer.",
long_description=LONG_DESCRIPTION,
long_description_content_type="text/markdown",
url="https://github.com/animator/titus2",
test_suite="test",
install_requires=["avro-python3 >= 1.8.2", "ply >= 3.4", "pyyaml >= 3.10", "numpy >= 1.6.1", "pytz >= 2015.4"],
tests_require=["avro-python3 >= 1.8.2", "ply >= 3.4", "pyyaml >= 3.10", "numpy >= 1.6.1", "pytz >= 2015.4"],
install_requires=["avro-python3>=1.8.2", "ply>=3.11", "pyyaml>=5.1.2", "numpy>=1.16.0", "pytz>=2019.1"],
tests_require=["avro-python3>=1.8.2", "ply>=3.11", "pyyaml>=5.1.2", "numpy>=1.16.0", "pytz>=2019.1"],
python_requires='>=3.4',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Intended Audience :: Education',
'Intended Audience :: Information Technology',
'Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering',
'Topic :: Scientific/Engineering :: Artificial Intelligence',
'Topic :: Software Development',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Natural Language :: English',
],
)

### details of dependencies:
#
# Tested in Python 3.4-3.8.
# Will not work in Python 2.x.
#
# Avro is required; it is an integral part of PFA.
# PLY is required; it is used to parse PrettyPFA and Inspector commandlines.
# avro-python3 is required; it is an integral part of PFA.
# ply is required; it is used to parse PrettyPFA and Inspector commandlines.
#
# PyYAML is an optional dependency; it is only used by the titus.reader.yamlToAst function.
# Numpy is an optional dependency; it is only used by the "interp", "la", "stat.test", and "model.reg" PFA libraries, as well as Titus producers.
Expand Down
2 changes: 1 addition & 1 deletion titus/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

__version_info__ = (1,0,0)
__version_info__ = (1,0,1)

__version__ = ".".join(map(str, __version_info__))

Expand Down

0 comments on commit 4d1acf5

Please sign in to comment.