Skip to content

Commit b07ba3f

Browse files
Add a notice about project maintainership to the README file (and change it from an RST to Markdown file).
1 parent 4c613d0 commit b07ba3f

File tree

4 files changed

+50
-47
lines changed

4 files changed

+50
-47
lines changed

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include setup.cfg .coveragerc tox.ini
2-
include TODO LICENSE.txt README.rst CODE_OF_CONDUCT.md
2+
include TODO LICENSE.txt README.md CODE_OF_CONDUCT.md
33
recursive-include tools *.py *.R
44
recursive-include doc *
55
prune doc/_build

README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Patsy
2+
3+
**Notice:** `patsy` is no longer under active development. As of August 2021,
4+
Matthew Wardrop (@matthewwardrop) and Tomás Capretto (@tomicapretto) have taken
5+
on responsibility from Nathaniel Smith (@njsmith) for keeping the lights on, but
6+
no new feature development is planned. The spiritual successor of this project
7+
is <a href="https://github.com/matthewwardrop/formulaic">Formulaic</a>, and we
8+
recommend those interested in new feature development contribute there. Those
9+
whose use-cases continue to be met by `patsy` can continue using this package
10+
with increased confidence that things will continue to work as is for the
11+
foreseeable future.
12+
13+
---
14+
15+
Patsy is a Python library for describing statistical models
16+
(especially linear models, or models that have a linear component) and
17+
building design matrices. Patsy brings the convenience of `R
18+
<http://www.r-project.org/>`_ "formulas" to Python.
19+
20+
[![PyPI - Version](https://img.shields.io/pypi/v/patsy.svg)](https://pypi.org/project/spec-classes/)
21+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/patsy.svg)
22+
![https://patsy.readthedocs.io/](https://img.shields.io/badge/docs-read%20now-blue.svg)
23+
![PyPI - Status](https://img.shields.io/pypi/status/patsy.svg)
24+
![https://travis-ci.org/pydata/patsy](https://travis-ci.org/pydata/patsy.png?branch=master)
25+
![https://coveralls.io/r/pydata/patsy?branch=master](https://coveralls.io/repos/pydata/patsy/badge.png?branch=master)
26+
![https://doi.org/10.5281/zenodo.592075](https://zenodo.org/badge/DOI/10.5281/zenodo.592075.svg)
27+
28+
- **Documentation:** <https://patsy.readthedocs.io/>
29+
- **Downloads:** <http://pypi.python.org/pypi/patsy/>
30+
- **Code and issues:** <https://github.com/pydata/patsy>
31+
- **Mailing list:** <[email protected]> (<http://groups.google.com/group/pydata>)
32+
33+
34+
## Dependencies
35+
36+
* Python (2.6, 2.7, or 3.3+)
37+
* six
38+
* numpy
39+
* Optional:
40+
* nose: needed to run tests
41+
* scipy: needed for spline-related functions like ``bs``
42+
43+
## Installation
44+
``pip install patsy`` (or, for traditionalists: ``python setup.py install``)
45+
46+
## License
47+
48+
2-clause BSD, see LICENSE.txt for details.

README.rst

-45
This file was deleted.

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
DESC = ("A Python package for describing statistical models and for "
77
"building design matrices.")
88

9-
LONG_DESC = open("README.rst").read()
9+
LONG_DESC = open("README.md").read()
1010

1111
# defines __version__
1212
exec(open("patsy/version.py").read())

0 commit comments

Comments
 (0)