Skip to content

Commit

Permalink
Fix linting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@ruaridhg
ruaridhg committed Jan 23, 2024
1 parent 001901e commit a09958e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 22 deletions.
18 changes: 9 additions & 9 deletions docs/pages/benchmarking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ layout: default

# Benchmarking

| Name | Short description | 🚦 | Used by |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-----: |
| [pyinstrument](https://pyinstrument.readthedocs.io/en/stable) | Python profiler. Tells you how long individual lines of code take to run, so you can focus on the slowest part of your program to speed it up. | 🟢 | |
| [snakeviz](https://jiffyclub.github.io/snakeviz/) | Browser based graphical viewer for the output of Python’s cProfile module. | 🟢 | |
| [asv](https://asv.readthedocs.io/en/stable/) | A tool for benchmarking Python packages over their lifetime. Allows you to write benchmarks and then run them against every commit in the repository, to identify where performance increased or decreased. | 🟢 | |
| [psutil](https://psutil.readthedocs.io/en/latest/) | System monitoring, profiling, limiting process resources and the management of running processes. | 🟢 | [Puppet Submitty](https://github.com/UCL-ARC/puppet-submitty), [Quality Workflow tool](https://github.com/UCL-ARC/qw) |
| [memray](https://bloomberg.github.io/memray/) | Memray tracks and reports memory allocations, both in Python code and in compiled extension modules. It also has a [plugin](https://pytest-memray.readthedocs.io/en/latest/) for easy integration with pytest. However, it only works on Linux and MacOS, and cannot be installed on other platforms. | 🟠 | |
| [line_profiler](https://pypi.org/project/line-profiler/) | It is a module for doing line-by-line profiling of functions. | 🟠 | |
| Name | Short description | 🚦 | Used by |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-------------------------------------------------------------------------------------------------------------------: |
| [pyinstrument](https://pyinstrument.readthedocs.io/en/stable) | Python profiler. Tells you how long individual lines of code take to run, so you can focus on the slowest part of your program to speed it up. | 🟢 | |
| [snakeviz](https://jiffyclub.github.io/snakeviz/) | Browser based graphical viewer for the output of Python’s cProfile module. | 🟢 | |
| [asv](https://asv.readthedocs.io/en/stable/) | A tool for benchmarking Python packages over their lifetime. Allows you to write benchmarks and then run them against every commit in the repository, to identify where performance increased or decreased. | 🟢 | |
| [psutil](https://psutil.readthedocs.io/en/latest/) | System monitoring, profiling, limiting process resources and the management of running processes. | 🟢 | [Puppet Submitty](https://github.com/UCL-ARC/puppet-submitty), [Quality Workflow tool](https://github.com/UCL-ARC/qw) |
| [memray](https://bloomberg.github.io/memray/) | Memray tracks and reports memory allocations, both in Python code and in compiled extension modules. It also has a [plugin](https://pytest-memray.readthedocs.io/en/latest/) for easy integration with pytest. However, it only works on Linux and MacOS, and cannot be installed on other platforms. | 🟠 | |
| [line_profiler](https://pypi.org/project/line-profiler/) | It is a module for doing line-by-line profiling of functions. | 🟠 | |

| [memory_profiler](https://pypi.org/project/memory-profiler/) | This package is no longer actively maintained. It is a python module for monitoring memory consumption of a process as well as line-by-line analysis of memory consumption. | 🔴 | |
| [memory_profiler](https://pypi.org/project/memory-profiler/) | This package is no longer actively maintained. It is a python module for monitoring memory consumption of a process as well as line-by-line analysis of memory consumption. | 🔴 | |
18 changes: 9 additions & 9 deletions docs/pages/dev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ layout: default

# Virtual environments

| Name | Short description | 🚦 | Used by |
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --- | :-----: |
| [conda](https://conda.io/projects/conda/en/latest/) | Conda quickly installs, runs, and updates packages and their dependencies. | 🟢 | |
| [pipenv](https://pipenv.pypa.io/en/latest/) | A tool that automatically creates and manages a virtualenv for your projects. | 🟠 | |
| [venv](https://docs.python.org/3/library/venv.html) | A tool to create isolated Python environments. | 🔴 | |
| [virtualenv](https://virtualenv.pypa.io/en/latest/) | A tool to create isolated Python environments which offers more features than venv. | 🟠 | |
| [pyenv](https://github.com/pyenv/pyenv) | A tool that lets you easily switch between multiple versions of Python. | 🟠 | |
| [poetry](https://github.com/python-poetry/poetry) | A tool that lets you build and package your project as well as managing dependencies | 🟠 | |
| Name | Short description | 🚦 | Used by |
| --------------------------------------------------- | ------------------------------------------------------------------------------------ | --- | :-----: |
| [conda](https://conda.io/projects/conda/en/latest/) | Conda quickly installs, runs, and updates packages and their dependencies. | 🟢 | |
| [pipenv](https://pipenv.pypa.io/en/latest/) | A tool that automatically creates and manages a virtualenv for your projects. | 🟠 | |
| [venv](https://docs.python.org/3/library/venv.html) | A tool to create isolated Python environments. | 🔴 | |
| [virtualenv](https://virtualenv.pypa.io/en/latest/) | A tool to create isolated Python environments which offers more features than venv. | 🟠 | |
| [pyenv](https://github.com/pyenv/pyenv) | A tool that lets you easily switch between multiple versions of Python. | 🟠 | |
| [poetry](https://github.com/python-poetry/poetry) | A tool that lets you build and package your project as well as managing dependencies | 🟠 | |

# Other
| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 | [RRED](https://github.com/UCL-ARC/rred-reports) |

| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 | [RRED](https://github.com/UCL-ARC/rred-reports) |
9 changes: 5 additions & 4 deletions docs/pages/refactoring.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ layout: default
---

# Refactoring Tools
| Name | Short description | 🚦 | Used by |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | --- | :-------------------------------------------------------------------------------------------------------------------: |
| [jedi](https://jedi.readthedocs.io/en/latest/) | Refactoring and autocompletion used in IDEs. | 🟢 | |
| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library. | | |

| Name | Short description | 🚦 | Used by |
| ----------------------------------------------------------- | -------------------------------------------- | --- | :-----: |
| [jedi](https://jedi.readthedocs.io/en/latest/) | Refactoring and autocompletion used in IDEs. | 🟢 | |
| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library. | | |

0 comments on commit a09958e

Please sign in to comment.