Skip to content

[DOC] Add PyPI description #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 30, 2019
Merged

[DOC] Add PyPI description #513

merged 5 commits into from
Jul 30, 2019

Conversation

hectormz
Copy link
Collaborator

PR Description

Please describe the changes proposed in the pull request:

  • Copy relevant sections from README.rst for PyPI project description

This PR resolves #495.

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:master, but rather from <your_username>:<branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.rst.
  1. Add a line to CHANGELOG.rst under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Quick Check

To do a very quick check that everything is correct, follow these steps below:

  • Run the command make check from pyjanitor's top-level directory. This will automatically run:
    • black formatting
    • pycodestyle checking
    • running the test suite
    • docs build

Once done, please check off the check-box above.

If make check does not work for you, you can execute the commands listed in the Makefile individually.

Documentation Changes

If you are adding documentation changes, please ensure the following:

  • Build the docs locally.
  • View the docs to check that it renders correctly.

Relevant Reviewers

Please tag maintainers to review.

Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this, @hectormz! Just a question regarding whether we can reduce duplication in the code, mostly for maintenance purposes.

@codecov
Copy link

codecov bot commented Jul 29, 2019

Codecov Report

Merging #513 into dev will decrease coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #513      +/-   ##
==========================================
- Coverage   92.88%   92.77%   -0.12%     
==========================================
  Files          10       10              
  Lines         872      872              
==========================================
- Hits          810      809       -1     
- Misses         62       63       +1

@hectormz
Copy link
Collaborator Author

@ericmjl Seems there is an issue finding the conda environment.

In this change, I considering making a test, but was unsure how to test something in setup.py, so I added the assert.

@ericmjl
Copy link
Member

ericmjl commented Jul 30, 2019

@hectormz, it's only failing on black at this point, I think! 😄 Could you black the entire codebase and push?

@hectormz
Copy link
Collaborator Author

Hi @ericmjl, black and pycodestyle were in disagreement about a line in setup.py. Maybe this fix will do the job

@ericmjl
Copy link
Member

ericmjl commented Jul 30, 2019

All good! Thanks @hectormz!

@ericmjl ericmjl merged commit c94ebe4 into pyjanitor-devs:dev Jul 30, 2019
@hectormz hectormz deleted the pypi-doc branch July 30, 2019 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] PyPI page has no project description
2 participants