Skip to content

Commit

Permalink
Improve runtime for installation using multithreading
Browse files Browse the repository at this point in the history
Add an endpoint for total files and corresponding badge
Update docs
  • Loading branch information
dormant-user committed Jun 9, 2024
1 parent 2aebb18 commit 73144f3
Show file tree
Hide file tree
Showing 18 changed files with 416 additions and 144 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
![GitHub repo size][label-repo-size]
![GitHub code size][label-code-size]
![GitHub code line][label-code-line]
![GitHub file count][label-file-count]

![GitHub Repo issues][label-issues-closed]
![GitHub Repo issues][label-issues-raw]
Expand Down Expand Up @@ -84,15 +85,19 @@
**Recommendations**

- Install `python` [3.10] or [3.11]
- Use an IDE like [PyCharm] or [VSCode]
- Create a dedicated [virtual environment]
- Use a dedicated [virtual environment]

**Install**
**Install Jarvis**
```shell
python -m pip install jarvis-ironman
```

**Initiate**
**Install Dependencies**
```shell
jarvis install
```

**Initiate - IDE**
```python
import jarvis

Expand All @@ -101,6 +106,13 @@ if __name__ == '__main__':
jarvis.start()
```

**Initiate - CLI**
```shell
jarvis start
```

> Use `jarvis --help` for usage instructions.
## Prerequisites
- **MacOS** <br> _Tested on **macOS High Sierra, Mojave, Catalina, Big Sur, Monterey and Ventura**_
- `System Preferences``Security & Privacy``Privacy`
Expand Down Expand Up @@ -219,7 +231,8 @@ Licensed under the [MIT License][license]

[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Jarvis
[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Jarvis
[label-code-line]: http://jarvis.vigneshrao.com/loc
[label-code-line]: http://jarvis.vigneshrao.com/line-count
[label-file-count]: http://jarvis.vigneshrao.com/file-count

[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Jarvis
[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Jarvis
Expand Down
21 changes: 16 additions & 5 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ <h2 align="center">Voice-Activated Natural Language UI</h2><p><a class="referenc
<img alt="GitHub Repo watchers" src="https://img.shields.io/github/watchers/thevickypedia/Jarvis" /></p>
<p><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/thevickypedia/Jarvis" />
<img alt="GitHub code size" src="https://img.shields.io/github/languages/code-size/thevickypedia/Jarvis" />
<img alt="GitHub code line" src="http://jarvis.vigneshrao.com/loc" /></p>
<img alt="GitHub code line" src="http://jarvis.vigneshrao.com/line-count" />
<img alt="GitHub file count" src="http://jarvis.vigneshrao.com/file-count" /></p>
<p><img alt="GitHub Repo issues" src="https://img.shields.io/github/issues-closed-raw/thevickypedia/Jarvis" />
<img alt="GitHub Repo issues" src="https://img.shields.io/github/issues-raw/thevickypedia/Jarvis" />
<img alt="GitHub Repo pr" src="https://img.shields.io/github/issues-pr-closed-raw/thevickypedia/Jarvis" />
Expand Down Expand Up @@ -102,21 +103,31 @@ <h1>Kick off<a class="headerlink" href="#kick-off" title="Permalink to this head
<p><strong>Recommendations</strong></p>
<ul class="simple">
<li><p>Install <code class="docutils literal notranslate"><span class="pre">python</span></code> <a class="reference external" href="https://docs.python.org/3/whatsnew/3.10.html">3.10</a> or <a class="reference external" href="https://docs.python.org/3/whatsnew/3.11.html">3.11</a></p></li>
<li><p>Use an IDE like <a class="reference external" href="https://www.jetbrains.com/pycharm/">PyCharm</a> or <a class="reference external" href="https://code.visualstudio.com/download">VSCode</a></p></li>
<li><p>Create a dedicated <a class="reference external" href="https://docs.python.org/3/tutorial/venv.html">virtual environment</a></p></li>
<li><p>Use a dedicated <a class="reference external" href="https://docs.python.org/3/tutorial/venv.html">virtual environment</a></p></li>
</ul>
<p><strong>Install</strong></p>
<p><strong>Install Jarvis</strong></p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>jarvis-ironman
</pre></div>
</div>
<p><strong>Initiate</strong></p>
<p><strong>Install Dependencies</strong></p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>jarvis<span class="w"> </span>install
</pre></div>
</div>
<p><strong>Initiate - IDE</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">jarvis</span>


<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="n">jarvis</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
</pre></div>
</div>
<p><strong>Initiate - CLI</strong></p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>jarvis<span class="w"> </span>start
</pre></div>
</div>
<blockquote>
<div><p>Use <code class="docutils literal notranslate"><span class="pre">jarvis</span> <span class="pre">--help</span></code> for usage instructions.</p>
</div></blockquote>
</section>
<section id="prerequisites">
<h1>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h1>
Expand Down
23 changes: 18 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
![GitHub repo size][label-repo-size]
![GitHub code size][label-code-size]
![GitHub code line][label-code-line]
![GitHub file count][label-file-count]

![GitHub Repo issues][label-issues-closed]
![GitHub Repo issues][label-issues-raw]
Expand Down Expand Up @@ -84,15 +85,19 @@
**Recommendations**

- Install `python` [3.10] or [3.11]
- Use an IDE like [PyCharm] or [VSCode]
- Create a dedicated [virtual environment]
- Use a dedicated [virtual environment]

**Install**
**Install Jarvis**
```shell
python -m pip install jarvis-ironman
```

**Initiate**
**Install Dependencies**
```shell
jarvis install
```

**Initiate - IDE**
```python
import jarvis

Expand All @@ -101,6 +106,13 @@ if __name__ == '__main__':
jarvis.start()
```

**Initiate - CLI**
```shell
jarvis start
```

> Use `jarvis --help` for usage instructions.
## Prerequisites
- **MacOS** <br> _Tested on **macOS High Sierra, Mojave, Catalina, Big Sur, Monterey and Ventura**_
- `System Preferences``Security & Privacy``Privacy`
Expand Down Expand Up @@ -219,7 +231,8 @@ Licensed under the [MIT License][license]

[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Jarvis
[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Jarvis
[label-code-line]: http://jarvis.vigneshrao.com/loc
[label-code-line]: http://jarvis.vigneshrao.com/line-count
[label-file-count]: http://jarvis.vigneshrao.com/file-count

[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Jarvis
[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Jarvis
Expand Down
23 changes: 18 additions & 5 deletions docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
![GitHub repo size][label-repo-size]
![GitHub code size][label-code-size]
![GitHub code line][label-code-line]
![GitHub file count][label-file-count]

![GitHub Repo issues][label-issues-closed]
![GitHub Repo issues][label-issues-raw]
Expand Down Expand Up @@ -84,15 +85,19 @@
**Recommendations**

- Install `python` [3.10] or [3.11]
- Use an IDE like [PyCharm] or [VSCode]
- Create a dedicated [virtual environment]
- Use a dedicated [virtual environment]

**Install**
**Install Jarvis**
```shell
python -m pip install jarvis-ironman
```

**Initiate**
**Install Dependencies**
```shell
jarvis install
```

**Initiate - IDE**
```python
import jarvis

Expand All @@ -101,6 +106,13 @@ if __name__ == '__main__':
jarvis.start()
```

**Initiate - CLI**
```shell
jarvis start
```

> Use `jarvis --help` for usage instructions.

## Prerequisites
- **MacOS** <br> _Tested on **macOS High Sierra, Mojave, Catalina, Big Sur, Monterey and Ventura**_
- `System Preferences` → `Security & Privacy` → `Privacy`
Expand Down Expand Up @@ -219,7 +231,8 @@ Licensed under the [MIT License][license]

[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Jarvis
[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Jarvis
[label-code-line]: http://jarvis.vigneshrao.com/loc
[label-code-line]: http://jarvis.vigneshrao.com/line-count
[label-file-count]: http://jarvis.vigneshrao.com/file-count

[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Jarvis
[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Jarvis
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Jarvis - Voice-Activated Natural Language UI

Installer
=========
.. automodule:: jarvis.lib.install
.. automodule:: jarvis.lib.installer
:members:
:undoc-members:

Expand Down
Loading

0 comments on commit 73144f3

Please sign in to comment.