Skip to content
Machine learning-assisted Python IDE
HTML Python JavaScript CSS Shell Makefile Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.akimous
.circleci
akimous
docker
images
tests
ui
.gitignore
.pylintrc
CHANGELOG.md
CODE_OF_CONDUCT.md
LICENSE
Makefile
README.md
poetry.lock
pyproject.toml

README.md

Akimous

PyPI version PyPI pyversions CircleCI

Akimous is a Python IDE with unique features boosting developers' productivity.

Features

  • Machine-learning-assisted/NLP-assisted context-aware auto completion
  • Beautifully rendered function documentation
  • Layered keyboard control (a more intuitive key binding than vim and Emacs)
  • Real-time code formatter
  • Interactive console (integration with IPython kernel)

Screenshot

For more information and documentation, visit the official website.

Installation

Prerequisite

  • Python 3.7 or 3.8
  • C/C++ compiler (required by some dependencies during installation)
  • A modern browser

Installing From PyPI

The recommended way for installing Akimous is through PyPI.

pip install -U akimous

Starting Application

Start it in the terminal. The browser should be automatically opened.

akimous
  • To see available arguments, do akimous --help.

Using Docker Image

If you have difficulty installing, or you are running in a cloud environment, try the prebuilt docker image.

docker run --mount type=bind,source=$HOME,target=/home/user -p 127.0.0.1:3179:3179 -it red8012/akimous akimous

Commands

Start the app by typing in the terminal (the browser will automatically open if available):

akimous

Options

  • --help: show help message and exit.
  • --host HOST: specify the host for Akimous server to listen on. (default to 0.0.0.0 if inside docker, otherwise 127.0.0.1)
  • --port PORT: The port number for Akimous server to listen on. (default=3179)
  • --no-browser: Do not open the IDE in a browser after startup.
  • --verbose: Print extra debug messages.

Development

Make sure you have recent version of the following build dependencies installed.

Run the following commands according to your need.

make # build everything
make test # run tests
make lint # run linters
make install # (re)install the package

Running make will install all Python and Javascript dependencies listed in pyproject.toml and ui/package.json automatically.

Contributing

This program is at pre-alpha stage. Please do report issues if you run into some problems. Contributions of any kind are welcome, including feature requests or pull requests (can be as small as correcting spelling errors) .

License

BSD-3-Clause

Links

You can’t perform that action at this time.