Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Java info to README #68

Merged
merged 1 commit into from
May 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ or by running

pip install -i https://pypi.org/simple/ filepattern


## Build and Install
Alternatively, ``filepattern`` can either be build inside a `conda` environment or independently outside of it directly from the source.

Expand Down Expand Up @@ -71,6 +70,20 @@ find_package(filepattern REQUIRED)
target_link_libraries(client_executable PRIVATE filepattern::filepattern)
```

### __Java API__

```filepattern``` also supplies a Java API. Maven can be used to build ```filepattern```. After installing Maven, the following steps can be used.

```bash
git clone https://github.com/PolusAI/filepattern.git
cd filepattern
mvn clean install
```

To build a jar instead of installing filepattern, ```mvn clean package``` can be used in place of ```mvn clean install```.

For more information of the Java API, see the [Java API documentation](https://filepattern.readthedocs.io/en/latest/Java.html)

<h2 id="filepattern-section"> Filepattern </h2>

When only a path to a directory and a pattern are supplied to the constructor of ``filepattern``, ``filepattern`` will iterate over the directory, matching the filenames in the directory to the ``filepattern``. The ``filepattern`` can either be supplied by the user or can be found using the ``infer_pattern`` method of ``filepattern``. For example, consider a directory containing the following files,
Expand Down
Loading