{"id":20461468,"url":"https://github.com/pythonbyte/employee-crud","last_synced_at":"2025-09-20T22:53:15.797Z","repository":{"id":181433503,"uuid":"332569522","full_name":"pythonbyte/employee-crud","owner":"pythonbyte","description":null,"archived":false,"fork":false,"pushed_at":"2021-01-24T22:30:24.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-01T04:12:26.773Z","etag":null,"topics":[],"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/pythonbyte.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,"governance":null}},"created_at":"2021-01-24T22:24:45.000Z","updated_at":"2021-01-24T22:30:26.000Z","dependencies_parsed_at":"2023-07-15T16:06:38.947Z","dependency_job_id":null,"html_url":"https://github.com/pythonbyte/employee-crud","commit_stats":null,"previous_names":["pythonbyte/employee-crud"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pythonbyte/employee-crud","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Femployee-crud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Femployee-crud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Femployee-crud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Femployee-crud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pythonbyte","download_url":"https://codeload.github.com/pythonbyte/employee-crud/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Femployee-crud/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276169661,"owners_count":25596956,"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","status":"online","status_checked_at":"2025-09-20T02:00:10.207Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-15T12:25:44.757Z","updated_at":"2025-09-20T22:53:15.781Z","avatar_url":"https://github.com/pythonbyte.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Description\n\nThis project is a CRUD for employees, and uses the zipcode api to search for zipcodes.\n\nhttps://github.com/pythonbyte/zipcode-api\n\n\n# Installing\n\nFirst step of installation is having Pipenv installed in your machine, if you doesn't have just use the command below:\n\n``` $ pip install pipenv ```\n\nNow after cloned the repository all you need to do is:\n\n```\n$ cd employeecrud/\n$ pipenv install\n$ python manage.py migrate\n$ python manage.py createsuperuser\n$ python manage.py runserver\n```\n\n# Testing\n\nTo test the application use:\n\n```$ python manage.py test```\n\n\n# API documentation\n\nThis API works with 2 simple endpoints:\n\n## Employees Endpoint\nThis endpoint works at the **/employees**, and lists the employees created and create new employees.\n\nGET data:\nStatus: 200 OK\n```\n[\n    {\n        \"id\": 1,\n        \"email\": \"teste@hot.com\",\n        \"job_role\": \"Developer\",\n        \"name\": \"Teste do Teste\",\n        \"phone\": \"31999999999\",\n        \"cep\": \"30330330\",\n        \"city\": \"Belo Horizonte\",\n        \"local_address\": \"Rua Campo Belo\",\n        \"neighborhood\": \"São Pedro\",\n        \"number\": 15,\n        \"state\": \"MG\"\n    }\n]\n```\n\nPost data:\nIn the post data in order to use the zipcode api is required to send the fields cep and number.\n```\n{\n    \"name\": \"Teste do Teste\",\n    \"email\": \"teste@hot.com\",\n    \"job_role\": \"Developer\",\n    \"phone\": \"31999999999\",\n    \"cep\": \"30330330\",\n    \"number\": \"15\"\n}\n```\nResponse data:\nStatus: 201 Created\n```\n[\n    {\n        \"id\": 1,\n        \"email\": \"teste@hot.com\",\n        \"job_role\": \"Developer\",\n        \"name\": \"Teste do Teste\",\n        \"phone\": \"31999999999\",\n        \"cep\": \"30330330\",\n        \"city\": \"Belo Horizonte\",\n        \"local_address\": \"Rua Campo Belo\",\n        \"neighborhood\": \"São Pedro\",\n        \"number\": 15,\n        \"state\": \"MG\"\n    }\n]\n```\n## Employee Detail Endpoint\nThis endpoint works at the **/employees/id** . This endpoint show the detail of a specific employee and you can Modify or Delete the object using the methods PUT and DELETE.\n\nGet data and Put Data response:\nurl: '/employees/1'\nStatus: 200 OK\n```\n{\n    \"id\": 1,\n    \"email\": \"teste@hot.com\",\n    \"job_role\": \"Developer\",\n    \"name\": \"Teste do Teste\",\n    \"phone\": \"31999999999\",\n    \"cep\": \"30330330\",\n    \"city\": \"Belo Horizonte\",\n    \"local_address\": \"Rua Campo Belo\",\n    \"neighborhood\": \"São Pedro\",\n    \"number\": 15,\n    \"state\": \"MG\"\n}\n```\nDelete response:\nStatus: 204 No Content\n```\n{\n  'message': 'User Teste do Teste was deleted.'\n}\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonbyte%2Femployee-crud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythonbyte%2Femployee-crud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonbyte%2Femployee-crud/lists"}