Skip to content

README.md

Latest commit

 

History

History
105 lines (74 loc) · 3.17 KB

README.md

File metadata and controls

105 lines (74 loc) · 3.17 KB
Raw

Neuron V1 Py DIY

A cleaned public build of the Neuron project.

This repository contains an early Flask-based assistant interface with modular Python tool files, HTML pages, and a public-safe project structure.

Neuron logo

What this repo includes

  • Flask web server entry point in Crystal/Armor/server.py
  • chat processing and model calls in Crystal/Armor/chat_prossesor_1.py
  • modular tool files for memory, time, system, and web actions
  • HTML pages in html/
  • project logos and static assets

Project structure

Crystal/Armor/
  server.py                Flask app and routes
  chat_base1.py            OpenRouter client setup
  chat_prossesor_1.py      Chat loop and tool orchestration
  memory_tools1.py         Memory-related tools
  time_tools1.py           Time/date tools
  system_tools1.py         System-related tools
  web_tools1.py            Web-related tools
html/
  *.html                   UI templates
requirements.txt           Core Python dependencies

Requirements

Core dependencies listed in requirements.txt:

  • Flask
  • bleach
  • markdown
  • openai
  • pymdown-extensions

Optional extras used by some web features:

  • ddgs
  • beautifulsoup4
  • playwright

Quick start

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
# edit .env with your real values
set -a && source .env && set +a
python Crystal/Armor/server.py

Then open the local Flask app in your browser.

Notes

  • This is a cleaned public build, not the full private working environment.
  • Private user data, old experiments, and generated runtime artifacts were removed before publication.
  • Runtime files such as user data are expected to be created locally and are ignored by git.
  • The OpenRouter client setup lives in Crystal/Armor/chat_base1.py and expects OPENROUTER_API_KEY.

Project docs

Changelog

See CHANGELOG.md for public-repo update notes.

License

This repository is released under the MIT License.

Why MIT here:

  • simple and standard
  • easy to reuse with attribution
  • minimal bureaucracy for a public code snapshot

Attribution and Courtesy Notice

This project is available under the MIT License, so people can use, modify, and build on it.

If you use this code or build on this project, please:

  • keep visible attribution to Daniil Timoshkin as the creator of the original foundation
  • mention Neuron as the original base when appropriate in public/project documentation
  • send a short note to the author so he knows the project/code is being used

Preferred contact for courtesy notifications: d.timing24@gmail.com

This is a courtesy request for transparency and credit, not an extra legal restriction beyond the MIT license.

Status

This repo is best viewed as a public snapshot of an earlier Neuron implementation: useful for inspection, learning, and reference.