Skip to content
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

Preparations for first pypi release #396

Open
wants to merge 25 commits into
base: master
Choose a base branch
from
Open

Conversation

agoscinski
Copy link
Contributor

@agoscinski agoscinski commented Dec 8, 2021

Preparation for making the first pypi release with package name librascal #362. You can see the test pypi page https://test.pypi.org/project/librascal/

I have installed it with

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple librascal

and then run the python tests with it to verify that it works

python -m pytest tests/python/python_binding_tests.py

Summary:

  • change python package name to librascal
  • cleaning README.rst (remove redundant and deprecated information, deleted docker part because I don't think we support it anymore)
  • structuring python dependencies in different files (see folder ./requirements) this covers issues Dependencies list is duplicated between documentation and requirements.txt #327 Merge requirements.txt or document them better #291
  • add author list with AUTHORS.txt
  • match project information (authors, version) in setup.py with docs/source/conf.py.in
  • nuke the librascal test.pypi index to then panic because I cannot recover it, to then find a hacky solution by making the tar.gz a zip and recover test.pypi index

Essential changes, so changes which are not just rascal->librascal, happen in:

  • setup.py
  • MANIFEST.in
  • ./requirements/*
  • README.rst
  • AUTHORS.txt
  • docs/source/conf.py.in

TODOs before sending review request

  • check if all links in README.rst works properly on github and on test pypi, do typo check
  • check if author, release in doc and test pypi agree with each other
  • download package for test pypi and check if everything necessary is included and if librascal can be used

EDIT[14.12.2021]
The README and CONRTIBUTING headers are now following correct header hierarchy

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

https://stackoverflow.com/a/24504437

@agoscinski agoscinski marked this pull request as ready for review December 8, 2021 20:35
@agoscinski agoscinski requested a review from Luthaf December 8, 2021 20:58
Copy link
Contributor

@Luthaf Luthaf left a comment

Choose a reason for hiding this comment

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

Looks good from a first pass. I'll check out this branch later to see if the sdist looks reasonable!

.circleci/config.yml Outdated Show resolved Hide resolved
AUTHORS.txt Outdated
Michele Ceriotti
Félix Musil
Max Veit
Alexander Goscinski
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be better to sort this file by some alphabetic order? I'm not sure how you generated it =)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

had some idea behind it, but it seems a bit random. changed to alphabetic

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
bindings/CMakeLists.txt Show resolved Hide resolved
@agoscinski agoscinski requested a review from Luthaf December 14, 2021 18:03
Copy link
Contributor

@Luthaf Luthaf left a comment

Choose a reason for hiding this comment

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

Looks good, just two small points and then this should be ready


Thank you for contributing to libRascal! To make sure your pull request gets
Thank you for contributing to libRascal! To make sure your pull request gets
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Thank you for contributing to libRascal! To make sure your pull request gets
Thank you for contributing to librascal! To make sure your pull request gets


Build Type
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

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

Usually the underline for the rst header is no longer than the title itself, i.e.

Build Type
^^^^^^^^^^

but if this renders fine it works for me.

@ceriottm
Copy link
Contributor

Shall we merge this and do the release? Wanted to point someone to using librascal, and it'd be easier if this was just a direct pip install away

@Luthaf
Copy link
Contributor

Luthaf commented Mar 11, 2022

Before doing a release, I would like to fix at least #383, otherwise users with a M1 apple computer will not be able to compile & install librascal. But we should update & merge this PR first!

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.

3 participants