{"id":17901916,"url":"https://github.com/osule/bucket-list-api","last_synced_at":"2026-05-16T22:32:40.816Z","repository":{"id":69543018,"uuid":"43997465","full_name":"osule/bucket-list-api","owner":"osule","description":null,"archived":false,"fork":false,"pushed_at":"2015-11-02T12:00:07.000Z","size":228,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-29T01:44:09.157Z","etag":null,"topics":["flask","jwt"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osule.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-10T06:25:04.000Z","updated_at":"2017-10-27T07:34:40.000Z","dependencies_parsed_at":"2023-03-10T10:02:07.117Z","dependency_job_id":null,"html_url":"https://github.com/osule/bucket-list-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osule/bucket-list-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osule%2Fbucket-list-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osule%2Fbucket-list-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osule%2Fbucket-list-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osule%2Fbucket-list-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osule","download_url":"https://codeload.github.com/osule/bucket-list-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osule%2Fbucket-list-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265429310,"owners_count":23763725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","jwt"],"created_at":"2024-10-28T16:04:07.189Z","updated_at":"2026-05-16T22:32:35.771Z","avatar_url":"https://github.com/osule.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"BucketList Application API [![Travis build badge](https://travis-ci.org/andela-osule/bucket-list-api.svg?branch=master)](https://travis-ci.org/andela-osule/bucket-list-api) [![Coverage Status](https://coveralls.io/repos/andela-osule/bucket-list-api/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/andela-osule/bucket-list-api?branch=master)\n--------------------------------------------------\nThis is a bucketlist service API built using Flask.\n\nBucketlist API allows you to manage your own bucketlists.\n\nFeatures include registering and authenticating a user;\ncreating, retrieving, updating and deleting bucketlist data and bucketlist item data.\n\n###MIME Type\nThe MIME type for requests is always application/json\n\n\n###EXAMPLE Requests\n```\ncurl -i -H 'Accept: application/json' 'http://localhost:5000/register'\n\nHTTP/1.0 200 OK\nContent-Type: application/json\nContent-Length: 159\nServer: Werkzeug/0.10.4 Python/2.7.10\nDate: Fri, 23 Oct 2015 17:33:15 GMT\n\n{\"message\": \"Welcome to the bucketlist service\", \"more\": \"To register make a POST request to /register ENDPOINT with [username] and [password]\"}\n```\n\n*NOTE THAT* upon login, the generated token must be specified in the subsequent request headers. An example of how this looks is:\n```\nAuthorization: Bearer \u003ctoken\u003e\n```\n\n###First Things, First\nYou should do an install of all package requirements in your python setup or go about creating a virtual environment. \n```\npip install -r requirements.txt\n```\n###Create Database Tables\nYou need to initialize database and tables. The following command does this and also adds a new user \nwith credentials: username _john_, password _oldman_\n```\npython manager.py createdb -t\n```\n\n###How To Start The Server\nRun the following command to start the server and begin listening for requests to each endpoints.\n```\npython run.py production\n```\n\nYou can get available environment options by running:\n```\npython run.py -h\n```\n\n###Available Endpoints\n\n| Endpoint | Description |\n| ---- | --------------- |\n| [POST /auth/login](#) | Login user. Session token is valid for an hour|\n| [POST /auth/logout](#) | Logout user. |\n| [POST /auth/register](#) |  Register user. Request should have _username_ and _password_ in form data. |\n| [POST /bucketlists/](#) | Create a new bucket list. Request should have _name_ in form data. |\n| [GET /bucketlists/](#) | List all the created bucket lists. |\n| [GET /bucketlists/:id](#) | Get single bucket list. |\n| [PUT /bucketlists/:id](#) | Update single bucket list. Request should have _name_ in form data. |\n| [DELETE /bucketlists/:id](#) | Delete single bucket list. |\n| [POST /bucketlists/:id/items](#) | Add a new item to this bucket list. Request should have _name_, _done_(defaults to False) in form data. |\n| [PUT /bucketlists/:id/items/:item_id](#) | Update this bucket list. Request should have _name_, _done_(True or False) in form data. |\n| [DELETE /bucketlists/:id/items/:item_id](#) | Delete this single bucket list. |\n| [GET /bucketlists?limit=20](#) | Get 20 bucket list records belonging to user. Allows for a maximum of 100 records. |\n| [GET /bucketlists?q=bucket1](#) | Search for bucket lists with bucket1 in name. |\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosule%2Fbucket-list-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosule%2Fbucket-list-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosule%2Fbucket-list-api/lists"}