ACCTOS: Free & Open Source Accounting Application

ACCTOS is a free and open source accounting application designed to simplify financial management for individuals and small businesses.

✨ Features

ACCTOS provides a set of features to help you manage a small business finances practically:

• 💸 Comprehensive Transaction Tracking: Easily record and categorize all your income and expenses to maintain a clear financial overview.
• 📊 Account Management: Set up and manage multiple bank accounts, track balances, and monitor financial flow across different categories.
• 📦 Inventory Management: Keep track of stock levels, manage products, and monitor asset values with integrated inventory features (zalihe).
• 🏷️ Flexible Categorization: Define and organize your financial data using custom categories (kategorije) for better reporting and analysis.
• 🌐 Open Source & Extensible: Built with Python, ACCTOS is fully open source, allowing for community contributions and easy customization to fit needs if you have them.

🚀 Installation

Follow these steps to get ACCTOS up and running on your local machine.

Prerequisites

Ensure you have Python 3.8+ installed on your system.

1. Clone the Repository

First, clone the ACCTOS repository to your local machine:

git clone https://github.com/TryCaze/acctos.git
cd acctos

2. Set Up a Virtual Environment (Recommended)

It's highly recommended to use a virtual environment to manage dependencies:

python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

3. Install Dependencies

ACCTOS uses a few Python libraries. Install them using pip:

pip install -r requirements.txt

Note: If requirements.txt is not present, you might need to install common libraries like SQLAlchemy or Tkinter (if it's a GUI app). For simplicity, we'll assume database.py handles standard Python DB operations or a requirements.txt will be added later.

4. Database Initialization

ACCTOS uses an internal database to store your financial data. The database.py script handles its setup.

python database.py

This command will initialize the necessary database structure.

💡 Usage

Once installed, you can launch and start using ACCTOS.

Running the Application

To start ACCTOS, simply run the main.py script:

source venv/bin/activate # If you're still in the virtual environment
python main.py

This will launch the ACCTOS application interface.

Example Workflow

1. Launch ACCTOS: Run python main.py.
2. Create an Account: Navigate to the racuni (accounts) section and add your bank accounts, cash accounts, etc.
3. Add Categories: Use the kategorije (categories) section to define categories for your income and expenses (e.g., "Salary", "Groceries", "Rent").
4. Record Transactions: Go to transakcije (transactions) to input your financial activities, linking them to accounts and categories.
5. Manage Inventory: If applicable, use zalihe (inventory) to add and track your stock items.

🗺️ Project Roadmap

ACCTOS is continuously evolving. Here are some of the planned features and improvements:

• Version 1.0.0:
  • Enhanced reporting and analytics features.
  • Export data functionality (CSV, PDF).
  • User interface improvements for better usability.
• Future Enhancements:
  • Multi-user support with different access levels.
  • Cloud synchronization for data backup and access across devices.
  • Localization and multi-language support.
  • Community-driven plugins and extensions(if any lol).
  • Regular security audits and performance optimizations.
  • User feedback incorporation for continuous improvement(if any lol).
  • Comprehensive documentation and tutorials for new users.
  • Collaboration with financial experts to enhance feature set.

🤝 Contributing

We welcome contributions from the community to make ACCTOS even better! Please follow these guidelines:

Code Style

• Use clear and descriptive variable/function names.

Pull Request Process

1. Fork the repository and clone it.
2. Create your feature branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -m 'feat: Add new reporting module').
4. Push to the branch (git push origin feature/your-feature-name).
5. Open a Pull Request, describing your changes and linking to any relevant issues.

Testing Requirements

• Ensure your code changes include appropriate unit and integration tests.
• All existing tests must pass.

📄 License

This project is licensed under the MIT License.

See the LICENSE file for full details.

MIT License

Copyright (c) 2023 TryCaze

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.