Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Dec 9, 2024
1 parent 5b9d9ae commit a319848
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ repos:
- id: check-yaml
- id: end-of-file-fixer
- id: mixed-line-ending
- id: trailing-whitespace
- id: trailing-whitespace
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[workspace]
resolver = "2"
members = [ "crates/*" ]
members = [ "crates/*" ]
10 changes: 5 additions & 5 deletions DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Follow the steps below to set up your development environment:

3. Install Rust and Python extensions for VSCode
Open VSCode, go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window. In the Extensions view, search for and install the following extensions:

- 'rust-analyzer': This extension provides advanced language support for Rust.
- 'CodeLLDB': This extension is an optional but recommended tool for developing and debugging Rust code.
- 'Jupyter': This extension provides Jupyter notebook support for VSCode.
Expand All @@ -78,7 +78,7 @@ Follow the steps below to set up your development environment:
source glama-env/bin/activate
Once the virtual environment is activated, the name of your virtual environment will appear on left side of the terminal prompt. This will let you know that the virtual environment is currently active.
Once the virtual environment is activated, the name of your virtual environment will appear on left side of the terminal prompt. This will let you know that the virtual environment is currently active.

- In the virtual environment, you can use the command `pip` to install packages that will be isolated from the global Python installation. Install the required packages for Glama development by running the following command:

Expand All @@ -105,7 +105,7 @@ Follow the steps below to set up your development environment:
This command will compile the Glama Rust code and install the resulting Python package into your active virtual environment. This means you can now import and use the Glama library in your Python scripts and Jupyter notebooks.

6. Open the `playground.ipynb` notebook.
6. Open the `playground.ipynb` notebook.
- Make sure that the notebook is set to use the virtual environment you created earlier. In Jupyter, you can do this by clicking on 'Kernel' > 'Change kernel' and selecting your virtual environment.
- In the first cell of the notebook, import the Glama library by running the following code:

Expand All @@ -130,7 +130,7 @@ Contributing to Glama
2. Clone the forked repository
On your GitHub account, navigate to the forked repository and click on the "Clone or download" button. Copy the URL.
Open a terminal and run the following git command:

.. code-block:: bash
git clone "url you just copied"
Expand Down Expand Up @@ -195,4 +195,4 @@ If you have any questions or want to discuss your work, please join our communit
Code Review Process
-------------------

After you submit your pull request, it will be reviewed by at least one core contributor. We'll provide feedback and may request changes. Once your pull request is approved, it will be merged into the main codebase and automatically released as an incremental version update on Pypi.
After you submit your pull request, it will be reviewed by at least one core contributor. We'll provide feedback and may request changes. Once your pull request is approved, it will be merged into the main codebase and automatically released as an incremental version update on Pypi.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Installation

::

pip install glama
pip install glama



Expand Down
2 changes: 1 addition & 1 deletion crates/glama/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ edition = "2021"
[dependencies]
anyhow = "1.0"
clap = { version = "4.5.1", features = ["derive"] }
pyo3 = { version = "*", features = ["abi3-py37", "extension-module"] }
pyo3 = { version = "*", features = ["abi3-py37", "extension-module"] }
2 changes: 1 addition & 1 deletion crates/glama/src/prelude.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pub use std::path::PathBuf;

pub use clap::{self, Arg, Subcommand, Parser, ArgAction};
pub use clap::{self, Arg, Subcommand, Parser, ArgAction};
2 changes: 1 addition & 1 deletion crates/hello/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
glama = { path = "../glama" }
glama = { path = "../glama" }
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ dependencies = []
[tool.maturin]
python-source = "python"
# "extension-module" tells pyo3 we want to build an extension module (skips linking against libpython.so)
features = ["pyo3/extension-module"]
features = ["pyo3/extension-module"]

0 comments on commit a319848

Please sign in to comment.