https://github.com/pytest-with-eric/pytest-technical-task
Technical Writer task for www.pytest-with-eric.com
https://github.com/pytest-with-eric/pytest-technical-task
Last synced: 9 months ago
JSON representation
Technical Writer task for www.pytest-with-eric.com
- Host: GitHub
- URL: https://github.com/pytest-with-eric/pytest-technical-task
- Owner: Pytest-with-Eric
- Created: 2023-07-20T07:02:34.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T05:32:13.000Z (about 2 years ago)
- Last Synced: 2025-01-29T12:30:00.505Z (11 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pytest Technical Interview Task
## Objective:
Write a 500-word article
## Keyword
how to use pytest
## Time:
~ 1 Hour
## Type:
Paid
## Prerequisites
- Fluent Written/Verbal English
- Strong understanding of the Markdown format
- Knowledge of Python, Pytest, GitHub
- Access to Repository
- Copywriting
## Instructions
- Write a keyword-driven 500-word article (Markdown Format) with a well-defined outline, taking the reader through a journey that explains a solution to their problem.
- Use the example code provided in the repository `master` branch in your article.
- Make a New Branch and Pull Request on the repository to submit your work.
- Use markdown formatted code snippets and screenshots from the Terminal to show output in the article.
- Ensure content uses correct grammar and DO NOT copy/paste from ChatGPT.
- Use style, outline and tone of voice inspiration from the [Pytest with Eric](https://pytest-with-eric.com/) website.
- Ensure article has a clear introduction, body, and conclusion.
- Address intention behind keyword search term in the article.
- Do thorough research on outlined topic and provide references.
- BONUS - Add a Catchy Heading for the article, containing the keyword.
- BONUS - Use images, diagrams, and screenshots to enhance content.
## Useful Tools
- https://stackedit.io/ (To edit Markdown)
- https://hemingwayapp.com/ (To improve writing simplicity)
- https://headlines.coschedule.com/ (To write engaging headlines)
- https://chat.openai.com/ (AI Assistant)
- https://bard.google.com/ (AI Assistant)
- https://grammarly.com/ (Writing Assistance/Grammar check)
- https://desktop.github.com/ (Version Control)
- https://docs.conda.io/en/latest/ (Package Manager for Python)
- https://github.com/features/copilot (AI Programming Assistance)
- https://code.visualstudio.com/ (Coding IDE)
## Link to Repository
https://github.com/Pytest-with-Eric/pytest-technical-task
## Example Article for Inspiration
https://pytest-with-eric.com/pytest-best-practices/pytest-benchmark/
## Code
The source code is a simple Python script that calculates the area of various shapes and can be found at `src/area_calculator.py`.
Unit Tests can be found at `tests/unit/test_area_calculator.py`
## Requirements
* Python (3.11+)
Please create a virtual environment and activate it.
Install the dependencies via the `requirements.txt` file using
```commandline
pip install -r requirements.txt
```
If you don't have Pip installed please follow instructions online on how to do it.
## How To Run the Unit Tests
To run the Unit Tests, from the root of the repo run
```commandline
pytest
```
or for more verbose output
```
pytest -v
```