A simple, powerful library management system that makes managing books, users, and loans a breeze!

RevSin is a modern library management system that helps librarians and library staff efficiently manage:

• 📖 Books: Add, search, and organize your book collection
• 👥 Users: Manage library members and staff accounts
• 📑 Loans: Track who borrowed what and when it's due
• 💰 Fines: Handle overdue books and fine payments

Perfect for: School libraries, public libraries, community centers, or any organization that lends books to people.

• 🎨 Beautiful Interface: Colorful, easy-to-use command-line tools
• 🚀 Fast & Reliable: Built with modern technology for speed
• 🔐 Secure: Proper user authentication and permissions
• 📱 API Ready: Integrate with websites or mobile apps
• 💡 Beginner Friendly: Clear documentation and helpful error messages

python --version
# Should show Python 3.12 or higher

Don't have Python? → Download it here

# Download RevSin
git clone <repository-url>
cd revsin

# Install everything you need (this might take a minute)
pip install uv  # Fast package manager
uv sync         # Install RevSin and dependencies

# Copy the example settings
cp env.example .env

# Edit .env with your database info (see "Easy Setup" below)

# Set up the database
rslms system init-db

# Create your first librarian account
rslms users create

# Start the system
python run.py

🎉 You're done! Visit http://localhost:8000/docs to see your library system!

No database installation needed! Use free cloud services:

1. Database: Sign up at NeonDB (free tier available)
2. Cache: Sign up at Upstash Redis (free tier available)
3. Copy the connection strings to your .env file

Example .env for cloud setup:

DATABASE_URL=postgresql://your-neon-db-connection-string
REDIS_URL=redis://your-upstash-redis-string
SECRET_KEY=make-this-a-random-string-123
ENVIRONMENT=development

If you prefer running everything locally:

1. Install PostgreSQL and Redis on your computer
2. Create a database named "revsin"
3. Update your .env file with local connections

RevSin comes with beautiful, colorful command-line tools:

# Check if everything is working
rslms system health

# Add a book to your library
rslms books add

# See all your users
rslms users list

# Check loan statistics
rslms loans stats

Build websites or mobile apps using our API:

• Browse books: GET /api/v1/books/
• Create loans: POST /api/v1/loans/
• Manage users: GET /api/v1/users/

📖 Full API Documentation: http://localhost:8000/docs

• Can do: Everything! Manage users, books, system settings
• Perfect for: Library directors, IT administrators

• Can do: Manage books and loans, help patrons
• Perfect for: Front desk staff, circulation desk workers

• Can do: Search books, view their loans, pay fines
• Perfect for: Library patrons, students, community members

"I get an error when starting!"

# Check system health - this will tell you what's wrong
python cli.py system health

# Or run the doctor for detailed diagnostics
python cli.py system doctor

"How do I add my first books?"

# Interactive book addition (asks you questions)
python cli.py books add

# Or add multiple books from a file
python cli.py books import my-books.csv

"Can I reset everything and start over?"

# ⚠️ WARNING: This deletes all data!
python cli.py system reset-db

• 📖 Documentation: Full documentation here
• 🐛 Found a bug?: Open an issue
• 💬 Questions?: Start a discussion

# Production server with multiple workers
python run_production.py

# Or manually with Gunicorn
uv run gunicorn src.revsin.main:app -w 4 -k uvicorn.workers.UvicornWorker

# Set up development environment
uv sync -G dev -G docs -G test

# Run tests
uv run pytest

# Format code
uv run black src/
uv run isort src/

# Check for issues
uv run flake8 src/
uv run mypy src/

rslms system health         # Check if everything is working
rslms system init-db        # Set up database tables
rslms system clear-cache    # Clear cached data
rslms system info           # Show system information

rslms users create          # Add new user (interactive)
rslms users list            # Show all users
rslms users search "john"   # Find users
rslms users stats           # User statistics

rslms books add             # Add book (interactive)
rslms books list            # Show all books
rslms books search "python" # Search books
rslms books available       # Show available books

rslms loans create          # Create new loan
rslms loans list            # Show all loans
rslms loans overdue         # Show overdue loans
rslms loans stats           # Loan statistics

MIT License - feel free to use RevSin in your library!

Built with ❤️ for librarians and book lovers everywhere.

Special thanks to:

• The FastAPI community
• Open source contributors
• Librarians who provided feedback