An all-in-one toolkit package to easy my Python work in my PhD.
PyhDToolkit: An all-in-one toolkit package for Python work in my PhD.
This repository is a package gathering a number of Python utilities for my work.
This code is compatible with
If for some reason you have a need for it, you should first install the prerequisites with:
Then, you can simply install it with:
pip install --editable git+https://github.com/fsoubelet/PyhDToolkit.git@master#egg=pyhdtoolkit
--editable flag should only be included if you intend to make some hotfix changes to the site-package.
If you intend on making actual changes, then you should clone this repository through VCS, and install it into a virtual environment.
git, this would be:
git clone https://github.com/fsoubelet/PyhDToolkit.git cd PyhDToolkit make
Tests are currently a work in progress. Testing builds are ensured after each commit through Travis-CI.
You can run tests locally with:
Standards, Tools and VCS
You can lint the code with:
Feel free to explore the
Makefile and make use of the functions it offers.
You will get an idea of what functionality is available to you by running:
This repository currently comes with an
environment.yml file to reproduce a fully compatible conda environment.
You can install this environment and add it to your ipython kernel by running:
A Dockerfile is included if you want to build a container image from source.
You can do so, building with the tag
simenv, with the command:
Alternatively, you can directly pull a pre-built image from Dockerhub with:
You can then run your container in interactive mode, and use the already activated conda environment for your work.
It is highly advised to run with
--init for zombie processes protection, see Tini for details.
Assuming you pulled the provided image from Dockerhub, the command is then:
docker run -it --rm --init fsoubelet/simenv
If you want to do some exploration through a
jupyter interface then you need to tell your container to install it first, as it is not bundled in miniconda, then add the custom environment kernelspec.
The following command will take care of all this:
docker run -it --rm --init -p 8888:8888 fsoubelet/simenv /bin/bash -c "/opt/conda/bin/conda install -c conda-forge jupyterlab -y --quiet > /dev/null && mkdir /opt/notebooks && /opt/conda/envs/PHD/bin/ipython kernel install --user --name=PHD && /opt/conda/bin/jupyter lab --notebook-dir=/opt/notebooks --ip='*' --port=8888 --no-browser --allow-root"
You can then copy the provided token and head to
localhost:8888 on your local machine.
Copyright © 2019-2020 Felix Soubelet. MIT License
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pyhdtoolkit-0.2.0.tar.gz (36.1 kB)||File type Source||Python version None||Upload date||Hashes View|