Skip to content

Commit d321aba

Browse files
PGijsbersmfeurer
authored andcommitted
Add long description (#856)
* Add long description. Add/order author names based on MLOSS paper. * Slightly more verbose short description. Refer to contribution guidelines elsewhere.
1 parent 1c025db commit d321aba

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
22

3-
A python interface for [OpenML](http://openml.org). You can find the documentation on the [openml-python website](https://openml.github.io/openml-python).
4-
5-
Please commit to the right branches following the gitflow pattern:
6-
http://nvie.com/posts/a-successful-git-branching-model/
3+
A python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning.
4+
It can be used to download or upload OpenML data such as datasets and machine learning experiment results.
5+
You can find the documentation on the [openml-python website](https://openml.github.io/openml-python).
6+
If you wish to contribute to the package, please see our [contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md).
77

88
Master branch:
99

setup.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# -*- coding: utf-8 -*-
22

3+
import os
34
import setuptools
45
import sys
56

@@ -12,13 +13,19 @@
1213
.format(sys.version_info.major, sys.version_info.minor, sys.version_info.micro)
1314
)
1415

16+
with open(os.path.join("README.md")) as fid:
17+
README = fid.read()
18+
1519
setuptools.setup(name="openml",
16-
author="Matthias Feurer, Jan van Rijn, Arlind Kadra, Andreas Müller, "
17-
"Pieter Gijsbers and Joaquin Vanschoren",
20+
author="Matthias Feurer, Jan van Rijn, Arlind Kadra, Pieter Gijsbers, "
21+
"Neeratyoy Mallik, Sahithya Ravi, Andreas Müller, Joaquin Vanschoren "
22+
"and Frank Hutter",
1823
author_email="feurerm@informatik.uni-freiburg.de",
1924
maintainer="Matthias Feurer",
2025
maintainer_email="feurerm@informatik.uni-freiburg.de",
2126
description="Python API for OpenML",
27+
long_description=README,
28+
long_description_content_type='text/markdown',
2229
license="BSD 3-clause",
2330
url="http://openml.org/",
2431
project_urls={

0 commit comments

Comments
 (0)