PyEnved

Codeberg repository | Help Screen

PyEnved is a Python-based TUI (terminal user interface) text editor with:

• Freely executable, non-sandboxed Python for powerful text manipulation
• A (heavily work-in-progress) detailed set of built-in functions
• A tree-like keybindings system (e.g., ^A ^F to open a file)
• Buffers, which can be managed, switched between, and have "modes" (determine how you can interact with the buffer)
• More, eventually

This project is nowhere near done. It is not yet usable. You are free to contribute or watch the project's development. To contribute, you may open issues or PRs; there is not yet a formal or structured process.

This project is licensed under the GNU GPLv3. It is FREE SOFTWARE, for which “free” refers to FREEDOM.

Getting Started

PyEnved is not packaged on any distributions, available anywhere for a standalone install, or published on PyPI; to get the program, you will have to clone it via Git.

Or, if you are a heathen (or you are uncomfortable with the CLI, in which case you probably should not be using PyEnved), you may click on the “…” next to the SSH/HTTPS link on the Codeberg repository, and click “Download ZIP” or “Download TAR.GZ”, then extract the archive that you receive.

Once you have done that, you will want to navigate to the src/ directory and run the main.py file in your terminal (of course, since it's a TUI).

Yoohoo! You have run the program. Now, you may be wondering “so how do I use it?”
That is a question whose answer frequently changes, given that this program is so early in development, but you can probably answer it by pressing ^A G S (all prefixed by Ctrl, PyEnved does that) to see the help screen. Or you can see a possibly up-to-date view of the help screen here, or just look at it on the Codeberg repository in texts/help.txt.

Contributing

You are free to contribute to PyEnved. As long as you know Python and are willing and wanting to contribute, you should be able to do that.
I soon plan on creating one contributing document to serve as the contributing guidelines for all of my projects (possibly with exceptions), but for now, this will do.
There are not many rules or standards to contributing. The general idea goes as such:

• Obviously, do not discriminate people, groups of them, be bigoted, racist, sexist, etc.; it would be absurd to even try. Regardless, I believe I have to say this.
• Do not add or suggest a way to do something if a way to do that thing already exists. If there is a problem with the current way, then fix or report that problem. This does not count simple wrappers of things that nobody wants to do manually.

Bug Reports

Bug reports: please make them!!! This program is riddled with small bugs and errors that crash and break the entire program. If you encounter a bug, you may do any one or multiple of these:

• Open an issue on the Codeberg repository
• Contact me with the contact info here (e-mail is most recommended)
• Perhaps submit code with a fix

Do note that Windows-related bugs are low-priority, as Windows is a proprietary and difficult-to-work with operating system that I do not care for.

Submitting Code

• Test your code. I will probably test it myself anyway but test. it.
• Use general style guides and recommendations for Python, and although the code style of PyEnved specifically is not documented, it is essentially PEP 8, so you should adhere to that. All in all, try not to deviate from the rest of the codebase.

And of course, starring the repository counts as contributing too.