8000 GitHub - Pritchad25/alx-backend-python
[go: up one dir, main page]

Skip to content

Pritchad25/alx-backend-python

Repository files navigation

Repo Title: ALX Backend Python

Table Of Contents

  1. About
  2. Requirements
  3. Getting Started
  4. Contributing
  5. License
  6. Repository Structure
  7. Author

About

This repository contains projects of the ALX Python Backend Track/Sprint, under the ALX Software Engineering Curriculum.

Requirements

  • Allowed editors: vi, vim, emacs
  • All your files will be interpreted/compiled on Ubuntu 18.04 LTS using python3 (version 3.7)
  • All your files should end with a new line
  • The first line of all your files should be exactly #!/usr/bin/env python3
  • A README.md file, at the root of the folder of the project, is mandatory
  • Your code should use the pycodestyle style (version 2.5.)
  • All your files must be executable
  • The length of your files will be tested using wc
  • All your modules should have a documentation (python3 -c 'print(__import__("my_module").__doc__)')
  • All your classes should have a documentation (python3 -c 'print(__import__("my_module").MyClass.__doc__)')
  • All your functions (inside and outside a class) should have a documentation (python3 -c 'print(__import__("my_module").my_function.__doc__)' and python3 -c 'print(__import__("my_module").MyClass.my_function.__doc__)')
  • A documentation is not a simple word, it’s a real sentence explaining what’s the purpose of the module, class or method (the length of it will be verified)
  • All your functions and coroutines must be type-annotated.

Getting Started

To get started with this project, do the following:

  1. Clone this repository: git clone https://github.com/Pritchad25/alx-backend-python.git
  2. Access any directory within the repository, for example: cd 0x02-python_async_comprehension
  3. Run any executable main file within the directory.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

ALX 2024 - alxafrica

Repository Structure

The following is a detailed description of the contents of this repository:

Project Description
0x00-python_variable_annotations Introduction To Python Variable Annotations
0x01-python_async_function Deep Dive Into Asynchronous Programming in Python
0x02-python_async_comprehension Mastery in Python Asynchronous Comprehensions
0x03-Unittests_and_integration_tests Mastery in Unittest and Integration Testing

Author

Pritchard Ncube - pritchad25

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0