Skip to content

Fix broken Python links & update testing section#219

Closed
egpbos wants to merge 6 commits into
NLeSC:masterfrom
egpbos:fix_python_links
Closed

Fix broken Python links & update testing section#219
egpbos wants to merge 6 commits into
NLeSC:masterfrom
egpbos:fix_python_links

Conversation

@egpbos

@egpbos egpbos commented Jun 2, 2020

Copy link
Copy Markdown
Collaborator

Below, describe what this Pull Request adds:

In #218 it turned out a few links were broken in the Python chapter, this PR fixes that. Note: this PR branches off of the branch of #218, so DON'T MERGE BEFORE #218.

@egpbos egpbos requested a review from bouweandela June 2, 2020 13:28
@egpbos egpbos marked this pull request as draft June 2, 2020 13:28
@egpbos egpbos marked this pull request as ready for review June 2, 2020 13:28
@egpbos egpbos marked this pull request as draft June 2, 2020 13:29
@egpbos

egpbos commented Jun 2, 2020

Copy link
Copy Markdown
Collaborator Author

Don't pull, I'm going to rebase and force push... sorry for the confusion.

@egpbos

egpbos commented Jun 2, 2020

Copy link
Copy Markdown
Collaborator Author

Ok, there we go, no more merge conflicts ;)

@egpbos egpbos marked this pull request as ready for review June 2, 2020 13:32
@egpbos

egpbos commented Jun 2, 2020

Copy link
Copy Markdown
Collaborator Author

The remaining errors are intermittent and should go away later (https://code.google.com/p/py-leveldb/ is there, so must have been a fluke, pylint.org is indeed actually down at the moment). Should rerun checks later to make sure.

@egpbos egpbos changed the title Fix broken Python links Fix broken Python links & update testing section Jun 4, 2020
Comment thread best_practices/language_guides/python.md
Comment thread best_practices/language_guides/python.md
Comment thread best_practices/language_guides/python.md
This is also the primary location where you should list your dependencies (find the currently installed packages with `pip freeze` or `conda list`).
Use the `install_requires` argument to list them.
Keep version constraints to a minimum; use, in order of descending preference: no constraints, lower bounds, lower + upper bounds, exact versions.
Use of `requirements.txt` is discouraged, unless necessary for something specific, see the [discussion here](https://github.com/NLeSC/guide/issues/156).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe you could add an external source instead of our GitHub issue?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I would prefer to link to the internal discussion, since that's what the recommendation was based on.

Set up continuous integration to test your installation script. Use `pyroma` (can be run as part of `prospector`) as a linter for your installation script.

There are two main distributions of Conda: [Anaconda](http://continuum.io/downloads) and [Miniconda](http://conda.pydata.org/miniconda.html). Anaconda is large and contains a lot of common packages, like numpy and matplotlib, whereas Miniconda is very lightweight and only contains Python. If you need more, the `conda` command acts as a package manager for Python packages.
For packaging your code, you can either use `pip` or `conda`. Neither of them is [better than the other](https://jakevdp.github.io/blog/2016/08/25/conda-myths-and-misconceptions/) -- they are different; use the one which is more suitable for your project. `pip` may be more suitable for distributing pure python packages, and it provides some support for binary dependencies using [`wheels`](http://pythonwheels.com). `conda` may be more suitable when you have external dependencies which cannot be packaged in a wheel.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks a bit like a duplicate of the section on what conda is

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Maybe so. Of course making a conda package and using conda for dependencies are two different things with different reasons for choosing it over pip/pypi. I'm open to suggestions, but let's do that in another PR.

Comment thread best_practices/language_guides/python.md
@egpbos

egpbos commented Jun 4, 2020

Copy link
Copy Markdown
Collaborator Author

Ok, I was confused, but most of your review comments are really for #218. I'll address them there and will figure out some weird git magic to make things make sense again :P

@bouweandela

Copy link
Copy Markdown
Member

I'll address them there and will figure out some weird git magic to make things make sense again :P

@egpbos Are you waiting for me to do something? Or did you simply not have the time to do this yet?

egpbos added a commit that referenced this pull request Apr 6, 2022
The comments were given in #219 already, but still apply here.
@egpbos egpbos closed this Apr 6, 2022
egpbos added a commit that referenced this pull request Apr 8, 2022
The first comments were given in #219 already, but still apply here.
Later also in #259 comments were
added that were applied in this commit. Furthermore, some additional
minor edits and an update of the wheels description.

Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>
egpbos added a commit that referenced this pull request Apr 14, 2022
The first comments were given in #219 already, but still apply here.
Later also in #259 comments were
added that were applied in this commit. Furthermore, some additional
minor edits and an update of the wheels description.

Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>
egpbos added a commit that referenced this pull request Apr 20, 2022
The first comments were given in #219 already, but still apply here.
Later also in #259 comments were
added that were applied in this commit. Furthermore, some additional
minor edits and an update of the wheels description.

Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>
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.

2 participants