Skip to content

grupy-sanca/curso-python

Repository files navigation

Python Course

Documentation Status Documentation Status

This repo contains the material for the Introductory Python course created by grupy-sanca.

All the material is in pt-br.

Check the material online here.

Find us in Facebook, Telegram, Discord, Instagram, Linkedin, Meetup and YouTube

How to use locally

  1. Install requirements:

    $ python -m venv env
    $ source env/bin/activate
    $ pip install -Ur requirements.txt

    You also need enchant, pyenchant and a pt-br dictionary (e.g. hunspell-pt-br) for spell checker.

    # On macOS
    $ brew update && brew install enchant
    $ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
    # On Debian based distros (linux Mint, Ubuntu...)
    $ sudo apt update && sudo apt install enchant-2 python3-enchant hunspell hunspell-pt-br
  2. Run the following command to generate the material in HTML:

    $ make html

    Another option is to produce a pdf using latex:

    $ make latexpdf
  3. To see the material locally open the page build/html/index.html in your favorite browser or the file build/latex/CursoIntrodutoriodePython.pdf in your favorite pdf viewer.

  4. To run the spell checker:

    $ sphinx-build -b spelling -nW source/ build/
  5. To run doctest:

    $ sphinx-build -b doctest -n source/ build/

How to generate instructor's guide

To generate the HTML:

$ SPHINXOPTS="-t instructors" make html

To generate the PDF:

$ SPHINXOPTS="-t instructors" make latexpdf

Or both together:

$ SPHINXOPTS="-t instructors" make latexpdf html

LaTeX dependencies

To generate the PDF, you need a modern LaTeX installation like texlive. To install the minimum packages on ArchLinux (btw):

$ sudo pacman -Syu texlive-{bin,core,latexextra}

How to contribute

Fork this repo, make your changes and open a Pull Request.

Don't forget to add your name to source/contribuidores.rst. Please, keep the list in alphabetical order.

LICENSE

This material is licensed under Creative Commons CC-BY-NC-SA 4.0 License