Skip to main content

An intelligent Python IDE

Project description

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 (with pip)
  • Git (for version control integration)
  • C/C++ compiler (may be 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

akimous-0.8.7.tar.gz (4.0 MB view hashes)

Uploaded Source

Built Distribution

akimous-0.8.7-py3-none-any.whl (4.2 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page