Code Monkey home page Code Monkey logo

pysteps's Introduction

Tutorial Generator

This project aims to automate the generation of tutorial blog posts with detailed steps in Markdown format. It utilizes the OpenAI API to generate text, allowing for the translation of all content into the specified destination language.

Installation

  1. Clone this repository to your local machine:

git clone <repository-url>

  1. Install the required dependencies:

pip install -r requirements.txt

  1. Set up your OpenAI API key:
    • Sign up for an account on the OpenAI website.
    • Generate an API key.
    • Set the API key as an environment variable or directly in the script.

Usage

To use this tool, follow these steps:

  1. Prepare a YAML file with the following structure:
    title: Tutorial Title
    description: Tutorial Description
    destination_language: english
    steps:
      - Step 1
      - Step 2
      - Step 3
      # Add more steps as needed
  2. Replace Tutorial Title and Tutorial Description with your desired title and description, and add the tutorial steps.

Run the script steps.py with the path to your YAML file as an argument:

python steps.py sample.yml

The script will generate a Markdown file with the translated tutorial content, ready for publication.

Configuration

You can customize the behavior of the tutorial generation process by modifying the YAML file. Specify the title, description, destination language, and the steps of the tutorial.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or improvements, feel free to open an issue or create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

pysteps's People

Contributors

digoreis avatar

Stargazers

Hugo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.