pyYC documentation

Version:

1.2.2

Release:

, built 25-10-16, 15:14

Author:

Yannick Copin <y.copin@ipnl.in2p3.fr>

Abstract:

This package should be used as a template for package structure, configuration and packaging, documentation, tests, gitlab continuous integration, etc. Work In Progress, feedback is welcome!

pyYC \pwik\ - A sample project

– Le packaging python, je n’y entrave que pouic.

– Utilise pyyc \pwik\!

• Gitlab repository

• Online documentation

• PyPI project

• Associated online course (in French): Analyse scientifique avec Python

Quick introduction

• Install the package
• Check the installation
• Build the documentation
• Run the tests

Detailed documentation

• Packaging (using pyproject.toml)
• Package initialization (__init__.py)
• Main entries (__main__.py)
• How-to generate documentation
  • Documentation configuration (conf.py)
  • Documentation content (index.rst)
  • How-to include notebooks
• How-to run code tests
  • Doctests
  • Dedicated tests
  • Test coverage
• How-to include data files (e.g. config/)
• How-to set-up Gitlab continuous integration
• More elements
• To do

Code documentation

Packages and modules

• pyyc package
  • pyyc.mod module
    • addition()
    • addition_int()
    • PYYC_PATH
    • read_config()
    • format_pkg_tree()
    • greetings()
  • Subpackages
    • pyyc.subpkgA package
      • pyyc.subpkgA.modA1 module
      • pyyc.subpkgA.modA2 module
    • pyyc.subpkgB package
      • pyyc.subpkgB.modB module

Main entries

• main

Tests

• Test definition

Notebooks

• Test notebook

Indices and tables

• Index

• Module Index

• Search Page