Skip to content

Commit 142de76

Browse files
arizsiddiquiarizsiddiqui
committed
Final Update
1 parent c5f90de commit 142de76

12 files changed

+143
-2
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can use the CLIK to also add, remove or modify keys, as and when required.
2626
## Installation
2727
You can either clone this repository or install it via pip
2828
```python
29-
pip install clik
29+
pip install python-clik
3030
```
3131

3232
## Usage

‎dist/clik-1.0-py3-none-any.whl

-9.04 KB
Binary file not shown.

‎dist/clik-1.0.tar.gz

-6.96 KB
Binary file not shown.

‎dist/python-clik-1.0.tar.gz

8.87 KB
Binary file not shown.

‎dist/python_clik-1.0-py3-none-any.whl

9.92 KB
Binary file not shown.

‎python_clik.egg-info/PKG-INFO

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
Metadata-Version: 2.1
2+
Name: python-clik
3+
Version: 1.0
4+
Summary: A CLI tool to keep your Secret/OAuth Keys Safe
5+
Home-page: https://github.com/MLSA-SRM/Project-CLIK
6+
Author: MLSA SRM
7+
Author-email: [email protected]
8+
License: UNKNOWN
9+
Description: # CLIK
10+
![](https://img.shields.io/github/forks/MLSA-SRM/Project-CLIK?style=for-the-badge)
11+
![](https://img.shields.io/github/stars/MLSA-SRM/Project-CLIK?color=purple&style=for-the-badge)
12+
![](https://img.shields.io/badge/contributors-4-orange.svg?style=for-the-badge)
13+
14+
CLIK is a command line interface tool to hide and manage your API keys and Secret/Auth tokens.
15+
This is for project managers for easy management of project-related keys and their distribution.
16+
<br><br>
17+
## How CLIK Works
18+
CLIK provides you with a command line interface that allows you to store your API Keys and Secret/Auth tokens in an encrypted JSON file.
19+
You are provided with an option to either store this key locally in a file, or making a note of it to store it anyway you like.
20+
The encrypted JSON file can safely be uploaded to VCS repositories, meaning access will only be granted to those who have been given the JSON decryption key by you.
21+
You can use the CLIK to also add, remove or modify keys, as and when required.
22+
## Built With
23+
| Software | Version |
24+
|----------|---------|
25+
| Python 3 | 3.7.1 |
26+
| Visual Studio Code| 1.50.1|
27+
28+
## Tested With
29+
| Operating System | Version(s) |
30+
|----------|-------------|
31+
| Microsoft Windows | Windows 10 |
32+
| Apple macOS | 10.15(Catalina), Beta 11.0(Big Sur) |
33+
34+
## Installation
35+
You can either clone this repository or install it via pip
36+
```python
37+
pip install python-clik
38+
```
39+
40+
## Usage
41+
Once you install CLIK, a short and concise documentation can be found br running the following command on your console:
42+
```python
43+
clik
44+
```
45+
## Initialising the JSON File
46+
To create a new file to store keys type the following command in your console:
47+
```python
48+
clik init
49+
```
50+
Now, you can specify all the keys you want to add in a step by step fashion.
51+
CLIK will automatically encrypt the file for you and generate your encryption key.
52+
Now you can either store the key locally or write it down for safekeeping.
53+
So now, your JSON file containing all your keys is ready for upload on your repository.
54+
## Adding/Subtracting Keys
55+
To add new keys to an existing JSON file, type the following command in your console:
56+
<br>
57+
### For Adding Keys
58+
```python
59+
clik FILENAME add
60+
```
61+
62+
### For Subtracting Keys
63+
```python
64+
clik FILENAME subtract
65+
```
66+
## For Modifying Keys
67+
To modify any key in an existing JSON file, type the following command in your console:
68+
```python
69+
clik FILENAME modify
70+
```
71+
## For Encrypting the Keys File
72+
To encrypt the JSON file, type the following command in your console:
73+
```python
74+
clik FILENAME enc
75+
```
76+
This will ask for any existing Keys to encrypt the JSON file with. If you have an existing Key,
77+
continue. Else, you can specify/create a new key for this new encryption.
78+
79+
## For Decrypting the Keys File
80+
To decrypt the JSON file, type the following command in your console:
81+
```python
82+
clik FILENAME dec
83+
```
84+
This will ask for any existing Keys to decrypt the JSON file with. If you have an existing Key,
85+
continue normally. Else, provide a path for the Key to be used for decryption.
86+
87+
> Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first.
88+
89+
## Help
90+
To check the syntax for any of the commands or their function, type the following command in your console:
91+
```python
92+
clik --help
93+
```
94+
95+
## Version
96+
To check the version of CLIK you're running, type the following command in your console:
97+
```python
98+
clik --version
99+
```
100+
> Note: Before uploading the JSON file containing your Keys to any VCS, it is recommended to store your .key file containing your Key to decrypt this encrypted JSON file in .gitignore of any other directory of your computer.
101+
102+
## Dependancies
103+
* [printy](https://github.com/edraobdu/printy)
104+
* [Python 3](https://python.org/)
105+
* [cryptography](https://github.com/pyca/cryptography)
106+
107+
## Contributors
108+
* [Mihir Singh](https://github.com/mihirs16)
109+
* [Anushka Agarwal](https://github.com/anushka17agarwal)
110+
* [Kushagra Gupta](https://github.com/KG-1510)
111+
* [Ariz Siddiqui](https://github.com/arizsiddiqui)
112+
113+
Platform: UNKNOWN
114+
Classifier: Programming Language :: Python :: 3
115+
Classifier: License :: OSI Approved :: MIT License
116+
Classifier: Operating System :: OS Independent
117+
Requires-Python: >=3.6
118+
Description-Content-Type: text/markdown

‎python_clik.egg-info/SOURCES.txt

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
README.md
2+
setup.py
3+
clikpython/__init__.py
4+
clikpython/clik.py
5+
clikpython/encrypt.py
6+
clikpython/helpVersion.py
7+
clikpython/json_convert.py
8+
clikpython/keys_init.py
9+
clikpython/menu_functions.py
10+
clikpython/utils.py
11+
python_clik.egg-info/PKG-INFO
12+
python_clik.egg-info/SOURCES.txt
13+
python_clik.egg-info/dependency_links.txt
14+
python_clik.egg-info/entry_points.txt
15+
python_clik.egg-info/requires.txt
16+
python_clik.egg-info/top_level.txt

‎python_clik.egg-info/dependency_links.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎python_clik.egg-info/entry_points.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[console_scripts]
2+
clik = clikpython.clik:main_menu
3+

‎python_clik.egg-info/requires.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
printy
2+
cryptography

‎python_clik.egg-info/top_level.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
clikpython

‎setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
long_description = fh.read()
55

66
setuptools.setup(
7-
name="clik",
7+
name="python-clik",
88
version="1.0",
99
entry_points={
1010
'console_scripts':[

0 commit comments

Comments
 (0)