Sample Python Application with Linting and CI

This repository contains a sample Python application with linting using Flake8 and Continuous Integration (CI) setup using GitHub Actions.

Contents

• Overview
• Project Structure
• Setup and Installation
• Running the Application
• Linting with Flake8
• Continuous Integration
• Contributing

Overview

The project demonstrates a basic setup for a Python application, including code linting and automated CI pipelines.

Project Structure

• app.py: A simple Python script with basic functionalities.
• .flake8: Configuration file for Flake8 linting.
• .github/workflows/python-ci.yml: GitHub Actions workflow for CI.

Setup and Installation

To set up the project locally:

1. Clone the repository.
2. Install Python 3.8 or higher.
3. (Optional) Set up a virtual environment.
4. Install dependencies: pip install -r requirements.txt

Running the Application

Run the application using the command: python app.py

Linting with Flake8

To lint the project, run: flake8 app.py

Continuous Integration

The project uses GitHub Actions for CI, which runs linting on every push or pull request to the main branch.

Contributing

Contributions to this project are welcome. Please ensure that your code adheres to the project's coding standards and passes all CI checks.