NLT : A swing at Natural Langage Transcoder

Our first aI pOwErEd app, helping noob programmers like us.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Our first local application, asking OpenAI-API to write code for us. The NLT should provide code corresponding to your prompt, allowing you to save it and edit it. If you ask for python code, you may be able to run it!

We made this for school as a way to hone our wobbly skills, and it shows.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these steps. You'll need python and docker to run this properly.

Prerequisites

You should possess an OpenAI API key, and have it in your environnement variable under 'OPENAI_API_KEY'.

• For Windows, inside a command prompt :

  setx OPENAI_API_KEY "your-api-key-here"

• Others :

  export OPENAI_API_KEY='your-api-key-here'

In case we were dumb enough to miss a step, please refer to OpenAI API documentation.

Installation

1. Clone the repo

   git clone https://github.com/Insiares/Projet-NLT.git

2. Install required packages

   pip install -r requirements.txt

3. Get the docker running

   cd ./Prototype_NLT/
   docker context create compose
   docker-compose -f docker-compose.yml up -d

4. CD into your /Prototype_NLT/ directory, and run the app inside your browser

   streamlit run app.py

(back to top)

Usage

Enter your demand in the first text area, if you modify it and want to ask again, don't forget to validate by hitting CTRL+Enter.

The outputed code is displayed below in an editor. You can play with the code, and even run it (If giant pasta god's willing). If you want to keep your code for further use, hit run at least once to save it inside the database.

You can then load previous session in the left sidebar. Choose your prompt and load it.

Might still be buggy, you can open an issue.

(back to top)

Roadmap

• Prototype
• Session Recording
• Save-enabled editable code block.
• Execute outputed code.
• [~] Prompt Engineering
  • [~] More Langages
  • Different assistant personality

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

You shall not feel the need to.

Should the extrem necessity emerges, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request
6. Leave Star on your way out !

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Please don't.

(back to top)

Acknowledgments

• Adrien for the awesome brief
• Antony for showing us the ropes of streamlit
• The genius who made the IA cover of Bloody Stream by Johnny Halliday, allowing me to maintain my sanity

(back to top)