Vitae

Vitae is a CV and resume manager designed to streamline the organization, updating, and sharing of your professional profiles.

It offers seamless integration with the Fediverse, enabling decentralized sharing and discovery of resumes across federated networks.

Features

• Manage multiple CVs and resumes from a single interface
• Quickly update and export your profiles
• Securely share your professional information through the Fediverse
• Retain full control over your career data while expanding your network

Project Overview

Vitae is developed using FastAPI and adheres to modern Python best practices. This project is currently in early development (v0.1.0) and actively encourages contributions.

Installation

Prerequisites

• Python 3.13
• uv — a high-performance Python package and project manager written in Rust

Setup

• Clone the repository:

mkdir -p vitae-project
cd vitae-project
git clone https://bolha.dev/vitae/backend-vitae .

• Use uv to synchronize and install project dependencies:

uv sync

Development

Vitae utilizes the following development tools:

• ruff: for linting and code formatting
• pytest: for running tests
• taskipy: for managing common development tasks

Common Tasks

Execute these commands to perform typical development activities:

# Run the linter
uv run task lint

# Format codebase
uv run task format

# Execute tests
uv run task test

# Run tests with coverage reporting
uv run task test-cov

# Launch the development server
uv run task run

# Launch the documentation server
uv run task doc-serve

Project Structure

vitae-project/
├── LICENSE
├── pyproject.toml
├── README.md
├── settings.toml                   # Configuration file for Dynaconf
├── uv.lock
├── docs                            # Documentation files
├── mkdocs.yml                      # Configuration file for MkDocs
├── vitae
│   ├── app.py                      # FastAPI application entry point
│   ├── blueprints/                 # API endpoints, routes, and resource modules
│   │   ├── cli/                    # Command Line Interface
│   │   │   ├── cli.py
│   │   │   └── __init__.py
│   │   └── __init__.py
│   └── extensions/                 # Modular components
│       ├── database/
│       │   └── db.py               # Database connection logic
│       └── __init__.py
└── tests/                         # Unit and integration tests
    ├── conftest.py
    └── __init__.py

Contributing

We welcome contributions! To contribute, please follow these steps:

1. Fork the repository
2. Create a feature branch (git switch -c feature/amazing-feature)
3. Implement your changes
4. Run tests to verify your changes (uv run task test)
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push your branch (git push origin feature/amazing-feature)
7. Open a Pull Request against the main branch

Coding Standards

• Follow PEP 8 style guidelines
• Use single quotes for string literals
• Limit lines to 120 characters
• Write tests for new features and bug fixes
• Run the linter before committing (uv run task lint)

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.