Skip to content

Getting Started with ECUtils

Hey there! 👋 Are you ready to dive into Elliptic Curve Cryptography with ECUtils? Great! Let's make sure you've got everything set up properly.

Before You Begin

Ensure that you have Python 3.8 or later installed on your machine. If not, head over to the official Python website and grab the latest version.

Easy Installation Steps

To get ECUtils up and running, just open up your terminal or command prompt and punch in:

pip install ecutils

This nifty little command fetches ECUtils from PyPI and installs it along with any dependencies it needs. Easy, right?

Prefer the Cutting-Edge Version?

If you're feeling adventurous and want the absolute latest and greatest, or if you're keen on contributing, you'll find the source over at our GitHub repo. Here's what you do to clone and install it:

  1. Whip open your terminal or command prompt.
  2. Get your clone on:
git clone https://github.com/isakruas/ecutils.git
  1. Navigate your way to the newly cloned directory:
cd ecutils
  1. And install with pip's help:
pip install .

If you're setting up for development and want to make live changes, install using:

pip install -e .

Checking the Install

Once you've installed ECUtils, give it a quick test by importing it in Python:

import ecutils

No errors? Brilliant! You're all set.

Time to Code!

Now that ECUtils is a part of your toolkit, you can start coding right away. Here's a peek at how to use it:

from ecutils.algorithms import DigitalSignature

# The rest of your code goes here

Need more guidance? Check out our documentation.

Keep in mind to stay updated; run this every now and then:

pip install --upgrade ecutils

Lend a Hand, Will Ya?

Ran into a snag? Got an idea? We've got a Bug Tracker for that. For contributing, just follow the yellow brick road to the CONTRIBUTING.md file in our repo.

Thank you for choosing ECUtils for your Elliptic Curve Cryptography needs. We're excited to see what you'll build!