Git Product home page Git Product logo

pyaddressbook's Introduction

PyAddressBook

PyAddressBook is a simple address book application built using FastAPI and SQLAlchemy for the backend and sqlite as the database. It provides a RESTful API for managing contacts.

Features

  • Create, read, update and delete contacts
  • List all contacts
  • Retrieve a contact by ID
  • Validation and error handling
  • Exception logging

Installation

Clone this repository and install the required packages by running

poetry install

Usage

To run the application, use the command

poetry run pyphonebookapi

The application will be available at http://localhost:8000.

API Endpoints

Method Endpoint Description
GET /addressbook/v1/contacts Retrieve a list of all contacts
GE /addressbook/v1/contacts/{contact_id} Retrieve a contact by ID
POST /addressbook/v1/contacts Create a new contact
PATCH /addressbook/v1/contacts/{contact_id} Update an existing contact by ID
DELETE /addressbook/v1/contacts/{contact_id} Delete a contact by ID

Testing

Tests can be run using the command

pytest

Note: this is a baisc app intended to learn/play with FastAPI and SQLAlchemy.

pyaddressbook's People

Contributors

gangleri avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.