Package: enade-py
enade-pyA library for facilitating data analysis over Enade microdata.Descriptionenade-pycomprises a set of functions for helping researchers and Educational
Data Mining (EDM) enthusiasts through the data mining process using Enade
microdata.The Enade microdata datasets are provided byInepand consist of informations from brazilian
undergraduate students and their performance on Enade (a national exam taken at
the end of the course).Enade datasets contain attributes related to:the exam itself;the student;the institution;performance on the exam;socioeconomic questions;and more.Getting StartedInstalling with pipTo install the latest release ofenade-py, just runpipinstallenade-pyManual InstallationIn order to set up the necessary environment:clone the repository on your machinegit clone https://github.com/mchoji/enade-py.gitcreate an environmentenade-pywith the help ofconda,conda env create -f environment.yamlactivate the new environment withconda activate enade-pyinstallenade-pywith:python setup.py install # or `develop`Optional and needed only once aftergit clone:install severalpre-commitgit hooks with:pre-commit installand checkout the configuration under.pre-commit-config.yaml.
The-n, --no-verifyflag ofgit commitcan be used to deactivate pre-commit hooks temporarily.installnbstripoutgit hooks to remove the output cells of committed notebooks with:nbstripout --install --attributes notebooks/.gitattributesThis is useful to avoid large diffs due to plots in your notebooks.
A simplenbstripout --uninstallwill revert these changes.Then take a look into thescriptsandnotebooksfolders.Dependency Management & ReproducibilityAbstract (unpinned) dependencies are kept inenvironment.yaml(for
development) and insetup.cfg(forpip)Concrete dependencies are kept inenvironment.lock.yamlfor the exact
reproduction of the development environment with:conda env export -n enade-py -f environment.lock.yamlFor multi-OS development, consider using--no-buildsduring the export.Update your current environment with respect to a newenvironment.lock.yamlusing:conda env update -f environment.lock.yaml --pruneData files are tracked withdvc. To pull the latest version, run the
following command aftergit cloneorgit pull:dvc pullProject Organization├── AUTHORS.rst             <- List of developers and maintainers.
├── CHANGELOG.rst           <- Changelog to keep track of new features and fixes.
├── LICENSE.txt             <- License as chosen on the command-line.
├── README.md               <- The top-level README for developers.
├── configs                 <- Directory for configurations of model & application.
├── data
│   ├── external            <- Data from third party sources.
│   ├── interim             <- Intermediate data that has been transformed.
│   ├── preprocessed        <- The final, canonical data sets for modeling.
│   └── raw                 <- The original, immutable data dump.
├── docs                    <- Directory for Sphinx documentation in rst or md.
├── environment.yaml        <- The conda environment file for reproducibility.
├── models                  <- Trained and serialized models, model predictions,
│                              or model summaries.
├── notebooks               <- Jupyter notebooks. Naming convention is a number (for
│                              ordering), the creator's initials and a description,
│                              e.g. `1.0-mc-initial-data-exploration`.
├── references              <- Data dictionaries, manuals, and all other materials.
├── reports                 <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures             <- Generated plots and figures for reports.
├── scripts                 <- Analysis and production scripts which import the
│                              actual PYTHON_PKG, e.g. train_model.
├── setup.cfg               <- Declarative configuration of this project.
├── setup.py                <- Use `python setup.py develop` to install for development or
|                              or create a distribution with `python setup.py bdist_wheel`.
├── src
│   └── enadepy             <- Actual Python package where the main functionality goes.
├── tests                   <- Unit tests which can be run with `py.test`.
├── .coveragerc             <- Configuration for coverage reports of unit tests.
├── .isort.cfg              <- Configuration for git hook that sorts imports.
└── .pre-commit-config.yaml <- Configuration of pre-commit git hooks.VersioningVersions defined according toSemVer. For the versions
available, see thetags on this repository.AuthorsM. Choji -mchojiLicenseenade-pyis licensed under the MIT License.
SeeLICENSEfor more information.NoteThis project has been set up using PyScaffold 3.2.3 and thedsproject extension0.4.
For details and usage information on PyScaffold seehttps://pyscaffold.org/.