Giter Club home page Giter Club logo

jupyter-tutorial's People

Contributors

dependabot[bot] avatar hofmannedv avatar pre-commit-ci[bot] avatar pyup-bot avatar silke avatar veit avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

jupyter-tutorial's Issues

Define audience in the documentation

At least one of the following audiences should be specified for each document:

  • data scientists
  • data engineers
  • data analysts
  • systems engineers

Update packaging docs to pep517 builds

See Do not use python setup.py ….
If you are invoking setup.py, you should be looking for the alternatives:

  • python setup.py uploadpipenv run twine
  • python setup.py installpipenv install
  • python setup.py testpipenv run tox
  • python setup.py sdist bdist_wheelpython -m pep517.build -s -b

Python 3.8 Notebook

Python 3.8 brings several features that are very interesting for scientific computing. They should be presented in a notebook.

Replace pipenv

Since pipenv doesn’t seem to be further developed (see If this project is dead, just tell us #4058 it’s time to look around for alternatives.

  • pip-tools for dependency management including automation of updates.
  • venv, possibly supplemented by pex or shiv.
  • pipdeptree print the dependency tree of the installed packages

Unfortunately, Poetry can’t install packages along with their dependencies in an explicitly specified virtual environment. However, this makes CI much easier.

Add heat extension

If the %%heat command is inserted at the top of a cell, it colorises the performance report.
You can install it with $ pipenv install py-heat-magic and load the extension with %load_ext heat.
See pyheatmagic and pyheat.

Automating code quality in product realisation

  • check-manifest
  • mypy for static typing
  • Black
  • isort
    • Config:
      [isort]
      atomic=true
      force_grid_wrap=0
      include_trailing_comma=true
      lines_after_imports=2
      lines_between_types=1
      multi_line_output=3
      not_skip=__init__.py
      use_parentheses=true
      
      known_first_party=attr
      known_third_party=hypothesis,pytest,setuptools,six,zope
      
    • For the detection of third party packages you can use seed-isort-config.
  • prettier for automated formatting of other file types
  • pre-commit offers a framework for running hooks before committing code.
    • Config pre-commit-config.yaml:
      repos:
        - repo: https://github.com/psf/black
          rev: 19.10b0
          hooks:
            - id: black
              language_version: python3.7
              # override until resolved: https://github.com/ambv/black/issues/402
          files: \.pyi?$
              types: []
      
        - repo: https://gitlab.com/pycqa/flake8
          rev: 3.7.9
          hooks:
            - id: flake8
              language_version: python3.7
      
        - repo: https://github.com/asottile/seed-isort-config
      rev: v1.9.4
          hooks:
            - id: seed-isort-config
      
        - repo: https://github.com/pre-commit/mirrors-isort
      rev: v4.3.21
          hooks:
            - id: isort
              additional_dependencies: [toml]
              language_version: python3.7
      
        - repo: https://github.com/pre-commit/pre-commit-hooks
          rev: v2.4.0
          hooks:
            - id: trailing-whitespace
            - id: end-of-file-fixer
            - id: debug-statements
      
    • Run pre-commit run --all-files

Add badges for all libs

  • Stars
  • Contributors
  • Activity
  • Downloads
  • License

e.g.

Name Stars Contributors Activity Downloads License
Jupyter-Tutorial stars contributors GitHub commit activity GitHub All Releases License

Manage npm

  1. npm init
  2. Lock dependencies: .npmrc
    $ npm config set save=true
    $ npm config set save-exact=true
    
  3. Secure your projects and tokens
    Don’t store the token directly in .npmrc but in .profile and then link to it:
    //registry.npmjs.org/:_authToken=${NPM_TOKEN}
    
    See Deploying with npm private modules
  4. Check for outdated dependencies
    $ npm outdated
    
    See also Greenkeeper
  5. preinstall, postinstall and test scripts
  6. NODE_ENV environment variables
    console.log("Node environment :"  + process.env.NODE_ENV);
    
    See also:
  7. Avoid devDependencies in production
    To install production dependencies, run
    $ npm install --production
    
    or
    $ NODE_ENV=production npm install
    
    See also Specifying dependencies and devDependencies in a package.json file

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.