tableau-projects-structure-mapping

This project parses an XML file to retrive Tableau's Projects information and creates an output CSV file containing a list of Project names with their directory structure from the respective Parent Project.

to read - https://docs.python.org/3/library/dataclasses.html

1. Project Setup

1.1. Install Python and Dependencies for project

Tip

Follow the guide available on Installing Python.

Steps:

1. Install Python and create a virtual env: make install
   • This command is dependent on pyenv python manager.
2. Confirm that your current directory's python version is correct: python --version
3. Start venv terminal: source .venv/bin/activate
4. Install python dependencies for the project: make install-deps

You can deactivate a venv by running deactivate in venv terminal when not running the code.

1.2. Update dependencies for future use

Important

It is important to update deps to keep code setup consistent for all developers.

1.2.1. Code Execution Dependencies

If your new changes in the code requires a change in dependencies then update the requirements.txt file by executing the command: make update-deps

1.2.2. Development Dependencies

If you have made any development related changes for example making use of Pylint, PyLance or coverage modules then add your package name and its version to dev-requirements.txt file.

2. General Development Commands

Important

Make sure to run all make commands in root directory using venv.

• Use virutal enviornment:
  • source .venv/bin/activate
  • You can deactivate a venv by running deactivate in venv terminal.
• Execute main file: make local
• Run Lint: make lint
• Check tests coverage: make check-coverage
• Run tests: make test