Chat with Carlos Vinicius about python, django and APIs

[thiagoferreiraw]

Base project for discussion: https://github.com/carv-silva/employeeLabs

[carv-silva]

construction api rest / django rest framework vs flask / docker or docker compose / model of document swagger /types of authenticated / unit test or tdd

[thiagoferreiraw]

Here's an initial proposed development plan @carv-silva. Let's discuss it on our call, and feel free to add new items as needed ;)

Python and fundamentals

• [ ] Basic control statements (if, else, for-loop, while, try-excep...)
• [ ] Data structures (lists, tuples, sets, dicts ...)
• [ ] Complexity in algorithms: Big O notation
• [ ] Object oriented programming
• [ ] Decorators

Databases

• [ ] When to use SQL Lite or postgres?
• [ ] SQL - DML commands: Insert, update, delete, select
• [ ] SQL - DDL commands: Create table, drop table, create index, etc
• [ ] Advanced queries using aggregations (sum, count, avg, ...)

Django

• [ ] ORM - Basic operations
• [ ] ORM - Query performance
• [ ] Docs: Implement swagger docs.

Rest APIs

• [ ] DRF or flask: what's the difference?
• [ ] HTTP verbs: GET, POST, PUT, PATCH, DELETE

Authentication

• [ ] Authentication types: cookie-based, token based, JWT, oauth2

Unit tests

• [ ] Difference between TDD and unit tests
• [ ] Using Django's test suite

Devops

• [ ] Creating a dockerfile to build an an app
• [ ] Creating a docker-compose.yml file to manage containers/services

Personal development

• [ ] Always use github as an portfolio for projects
• [ ] Keep your linkedin up-to-date

[thiagoferreiraw]

@carv-silva , additionally, I suggest you implement these improvements in the ttps://github.com/carv-silva/employeeLabs project so we have a better grip of a real scenario:

New Models

Department - Instead of having the department set as an string/charfield in the database, let's make it into a foreign key. We should have a new model called Department, with at least the fields: id, name, budget. Feel free to add more fields 🤘

Payroll - Let's create a model to record the employee salaries every month, so we can extract some reports. I suggest these fields to begin with, but feel free to add more: id, month, employee (fk), gross_salary, taxes, benefits, net_salary. We can also calculate the taxes on a fixed number like 11% on top of the gross salary, for fun ;)

Employee model: We already have this, but let's add more fields, I suggest: `start_date, termination_date.

New endpoints

• Payroll: Let's create an endpoint to list payroll per month.
• Departments: List departments
• Reports: Here we can create endpoints to list some reports based on the payroll, like: Total salary of an employee per year, total salary of a department per year and so on. Let's be creative here since reporting is crucial for most businesses.

Endpoint improvements

• For all of those endpoints, we need to have:
• • Pagination, since there might be a lot of data
• • Filterings: we need to be able to search for employee name, start_date, termination_date, salary...
• • Let's keep an eye on query performance here ;)
• Swagger docs ;)

Authentication

• Most applications have authentication and different permission levels. Let's create the following roles:
• • Super Admin: Access to everything
• • Employee management: can only create/update employees. Not allowed to change payroll.
• • Payroll clerk: Can only change payroll. Not allowed to change employees.

Devops

• Start using postgres
• Creating a dockerfile to build an an app
• Creating a docker-compose.yml file to manage containers/services

[thiagoferreiraw]

Another roadmap you can take a look: https://roadmap.sh/backend

[carv-silva]

Department modified and payroll create, doubt emerged to creating of endpoint list payroll, the main question is the list will be created with ListView

[carv-silva]

create new branch developer for pull request