Skip to content

Commit 9a8ec8a

Browse files
committed
Created a publish script for release.
1 parent 88b8f7d commit 9a8ec8a

File tree

6 files changed

+40
-31
lines changed

6 files changed

+40
-31
lines changed

MANIFEST.in

Lines changed: 0 additions & 1 deletion
This file was deleted.

README

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Typesense Python Client
2+
3+
Python client for the Typesense API: https://github.com/typesense/typesense
4+
5+
Follows the Typesense [API specification](https://github.com/typesense/typesense-api-spec).
6+
7+
## Installation
8+
9+
```
10+
$ pip install typesense
11+
```
12+
13+
You can also add `typesense` to your project's `requirements.txt`.
14+
15+
## Usage
16+
17+
See the detailed [API documentation](https://typesense.org/api).
18+
19+
## Contributing
20+
21+
Bug reports and pull requests are welcome on GitHub at [https://github.com/typesense/typesense-python].
22+
23+
## License
24+
25+
`typesense` is distributed under the Apache 2 license.
26+
27+
28+

dev.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
m2r==0.1.13

publish.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env bash
2+
rm -rf dist/*
3+
python setup.py sdist
4+
twine upload dist/*

setup.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
from distutils.core import setup
22

3+
from m2r import parse_from_file
4+
5+
long_description = parse_from_file('README.md')
6+
37
setup(
48
name='typesense',
5-
version='0.1.0',
9+
version='0.2.2',
610
packages=['examples', 'typesense'],
711
url='https://typesense.org',
812
license='Apache 2.0',
913
author='Typesense',
1014
author_email='[email protected]',
11-
description='Python client for Typesense, an open source and typo tolerant search engine.'
15+
description='Python client for Typesense, an open source and typo tolerant search engine.',
16+
long_description=long_description,
1217
)

0 commit comments

Comments
 (0)