Skip to content

Commit

Permalink
Fix readme and setup.py to appease twine (#373)
Browse files Browse the repository at this point in the history
* DOC fix readme to appease twine

* MAINT specify long description type to appease twine

* MAINT update change log
  • Loading branch information
jacksonlee-civis committed Mar 5, 2020
1 parent d01f92c commit ab19a8a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Fixed `effective_n_jobs` to account for `n_jobs=None`, which is a default for the LogisticsRegression in `sklearn=0.22.x`. (#365)
- Fixed crashing on NULL fields in `civis sql` CLI command (#366)
- Fixed a bug related to creating a ModelPipeline from a registered model. (#369)
- Fixed readme and setup.py to appease twine. (#373)

### Changed
- Made repeated invocations of `civis.tests.create_client_mock` faster by caching the real APIClient that the mock spec is based on (#371)
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ The Civis API may also be directly accessed via the ``APIClient`` class.
client = civis.APIClient()
database = client.databases.list()
See the `full documentation <https://civis-python.readthedocs.io>`_ for a more
See the `documentation <https://civis-python.readthedocs.io>`_ for a more
complete user guide.


Expand Down Expand Up @@ -219,7 +219,7 @@ Command-line Interface (CLI)
----------------------------

After installing the Python package, you'll also have a ``civis`` command accessible from your shell. It surfaces a commandline interface to all of the regular Civis API endpoints, plus a few helpers. To get started, run ``civis --help``.
Please see the `full documentation <https://civis-python.readthedocs.io/en/stable/cli.html>`_ for more details.
Please see the `CLI documentation <https://civis-python.readthedocs.io/en/stable/cli.html>`_ for more details.


Contributing
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ def main():
data_files=[(os.path.join('civis', 'tests'),
glob(os.path.join('civis', 'tests', '*.json')))],
long_description=README,
long_description_content_type="text/x-rst",
install_requires=[
"pyyaml>=3.0,<=5.99 ; python_version != '3.4'",
"pyyaml>=3.0,<=5.2 ; python_version == '3.4'",
Expand Down

0 comments on commit ab19a8a

Please sign in to comment.