How to use it

Welcome to the Transactify!

This tool was made as a way to convert Quicken Files (.qfx) files into JSON so it is easy to handle the information inside those files.

The following steps are made for macOS, but as this is a simple python tool it should work on Windows and Linux as well.

First, you need to be sure you have git and python installed in your system.

Installing Git and Python on macOS

Installing Git

1. Open Terminal (you can find it in Applications > Utilities or use Spotlight search).
2. Install Xcode Command Line Tools, which includes Git:

   xcode-select --install
   

3. Follow the on-screen instructions to complete the installation.
4. Verify the installation by typing:

   git --version
   

Installing Python

1. Visit the official Python website: https://www.python.org/downloads/
2. Download the latest version of Python for macOS.
3. Open the downloaded .pkg file and follow the installation wizard.
4. Verify the installation by opening Terminal and typing:

   python3 --version
   

That's it! You now have Git and Python installed on your macOS system.

Cloning a Git Repository

To clone the Transactify repository, follow these steps:

1. Open Terminal on your macOS.

2. Navigate to the directory where you want to clone the repository. For example, to clone it to your Documents folder:

   cd ~/Documents
   

3. Clone the repository using the following command:

   git clone https://github.com/carlosfelgarcia/Transactify.git
   

4. Once the cloning is complete, navigate into the new directory:

   cd Transactify
   

You have now successfully cloned the Transactify repository to your local machine.

Setting up and Running the Transactify Project

Before running the project, ensure you have all the necessary dependencies installed.

Installing Dependencies

1. Navigate to the Transactify repository directory:

   cd ~/Documents/Transactify
   

2. Create and activate a virtual environment (optional but recommended):

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install the required libraries:

   pip install -r requirements.txt
   

Option 1: Setting up and using the alias

1. Ensure you're in the Transactify repository directory.

2. Run the setup script:

   python3 setup.py
   

3. Apply the changes by either:

   • Restarting your terminal, or
   • Running:

     source ~/.zshrc
     

4. You can now use the transactions command from anywhere in your terminal to run the Transactify project.

Note: If you encounter permission issues, make the script executable:

chmod +x setup.py

Option 2: Running without installing the alias

If you prefer not to install the alias, you can run the project directly:

1. Navigate to the Transactify repository directory:

   cd ~/Documents/Transactify
   

2. Activate the virtual environment (if you created one):

   source .venv/bin/activate
   

3. Run the main script:

   python3 main.py
   

This method allows you to run the project without modifying your .zshrc file.

Choose the option that best fits your workflow. Option 1 provides a convenient shortcut, while Option 2 offers more control and doesn't modify your shell configuration.

Remember to activate your virtual environment (if used) each time you want to run the project using Option 2.