Move to package structure

[cdce8p]

This PR is based on the discussion in #87
I've split up the code into multiple files. Additionally I refactored the tests to use pytest instead of unittest.

--
Until #87 is merged, this PR contains a commit with those changes. I will remove it once done.

[codecov]

Codecov Report

Merging #88 (c5ea738) into dev-4.0.0 (8e2c4f1) will increase coverage by 0.04%.
The diff coverage is 98.99%.

@@              Coverage Diff              @@
##           dev-4.0.0      #88      +/-   ##
=============================================
+ Coverage      98.94%   98.99%   +0.04%     
=============================================
  Files              1        6       +5     
  Lines            380      397      +17     
=============================================
+ Hits             376      393      +17     
  Misses             4        4              

Impacted Files	Coverage Δ
piplicenses/parse.py	94.91% <94.91%> (ø)
piplicenses/table.py	98.93% <98.93%> (ø)
piplicenses/__main__.py	100.00% <100.00%> (ø)
piplicenses/argparse.py	100.00% <100.00%> (ø)
piplicenses/const.py	100.00% <100.00%> (ø)
piplicenses/utils.py	100.00% <100.00%> (ø)
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8e2c4f1...c5ea738. Read the comment docs.

[raimon49]

I've prepared the following remote branch.
https://github.com/raimon49/pip-licenses/tree/dev-4.0.0

It would be good to consolidate the results of this P-R into a dev-4.0.0 branch.

[cdce8p]

I rebased the branch onto dev-4.0.0, so it's ready for review.

I will however leave it in Draft status until the issue with the squash commit is resolved: #87 (comment)
That will only require a rebase, so the code itself won't change.

[cdce8p]

I've rebased the branch. The PR is ready for review now

[cdce8p]

@raimon49 Did you get a chance to take a look at this yet?

[raimon49]

@cdce8p Overall, I am willing to distribute pip-licenses under the MIT license.

So, I would like all piplicenses/*.py files to have a comment with the license clause.

[cdce8p]

@cdce8p Overall, I am willing to distribute pip-licenses under the MIT license.

So, I would like all piplicenses/*.py files to have a comment with the license clause.

I agree, the MIT license is a really good fit for this project. However I don't believe it's really necessary to add it to every file header. In almost all cases it's enough to have a LICENSE file distributed with the package. Doing it that way, it's also way easier to update the copyright notice (eg. to update the year). The only cases I can think of including the license in every file use the GPL License and even then I personally would advise against it.

[raimon49]

The split design of the package structure looks like a good job.

After this PR is merged, or just before v-4.0.0 ships, I may add a simple link to the license file URLs and a declaration of character encoding to all files.

[cdce8p]

After this PR is merged, or just before v-4.0.0 ships, I may add a simple link to the license file URLs and a declaration of character encoding to all files.

I don't think it's necessary, but I can understand your intension. I've added a short note to the top of every source file:

# ---------------------------------------------------------------------------
# Licensed under the MIT License. See LICENSE file for license information.
# ---------------------------------------------------------------------------

What do you think?

--

Character encodings: I believe they aren't necessary. utf-8 is the default in Python 3. See stackoverflow. Vim doesn't need it either.

--

#!/usr/bin/env python: Also not necessary, since the python files aren't executed directly.

[cdce8p]

@raimon49 Can you squash merge this PR (and all other subsequent ones for the dev branch) as well?

[raimon49]

@cdce8p

I've added a short note to the top of every source file:

Thanks for the work. It looks good.

Character encodings: I believe they aren't necessary. utf-8 is the default in Python 3. See stackoverflow. Vim doesn't need it either.

Okay, I understand.

[raimon49]

Can you squash merge this PR (and all other subsequent ones for the dev branch) as well?

Yes, we will adopt that workflow for the merge to dev-4.0.0.

[cdce8p]

Can you squash merge this PR (and all other subsequent ones for the dev branch) as well?

Yes, we will adopt that workflow for the merge to dev-4.0.0.

Thanks 👍🏻