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

Improve main SDK page #1047

Merged
merged 3 commits into from
Oct 25, 2023
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
236 changes: 127 additions & 109 deletions source/developers/minio-drivers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,113 +12,81 @@ Software Development Kits (SDK)

MinIO publishes the following Software Development Kits (SDK):

1. :ref:`.NET <dotnet-sdk>`
2. :ref:`Golang <go-sdk>`
3. :ref:`Haskell <haskell-sdk>`
4. :ref:`Java <java-sdk>`
5. :ref:`JavaScript <javascript-sdk>`
6. :ref:`Python <python-sdk>`
7. :ref:`C++ <cpp-sdk>`

.. _cpp-sdk:

C++ (``minio-cpp``)
-------------------
- :ref:`Go <go-sdk>`
- :ref:`Python <python-sdk>`
- :ref:`Java <java-sdk>`
- :ref:`.NET <dotnet-sdk>`
- :ref:`JavaScript <javascript-sdk>`
- :ref:`C++ <cpp-sdk>`
- :ref:`Haskell <haskell-sdk>`

.. _go-sdk:

Reference
`MinIO C++ SDK Reference <https://minio-cpp.min.io/>`__
Go
--

Install
- ``vcpkg``
GitHub: `minio/minio-go <https://github.com/minio/minio-go>`__

.. code-block:: shell
:class: copyable
Latest Version: |go-sdk-version|

vcpkg install minio-cpp
Quickstart Guide: :doc:`/developers/go/minio-go`

- Source

.. code-block:: shell
:class: copyable
Reference: :doc:`/developers/go/API`

git clone https://github.com/minio/minio-cpp
cd minio-cpp
wget --quiet -O vcpkg-master.zip https://github.com/microsoft/vcpkg/archive/refs/heads/master.zip
unzip -qq vcpkg-master.zip
./vcpkg-master/bootstrap-vcpkg.sh
./vcpkg-master/vcpkg integrate install
cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./vcpkg-master/scripts/buildsystems/vcpkg.cmake
cmake --build ./build --config Debug
Download from GitHub
.. code-block:: shell
:class: copyable

.. _dotnet-sdk:
go install github.com/minio/minio-go/v7@latest

.NET (``minio-dotnet``)
-----------------------

Latest Version
|dotnet-sdk-version|
.. _python-sdk:

Reference
:doc:`MinIO .NET SDK Reference </developers/dotnet/minio-dotnet>`
Python
------

Download from NuGet
Run the following command in the NuGet Package Manager Console.
GitHub: `minio/minio-py <https://github.com/minio/minio-py>`__

.. code-block:: shell
:class: copyable
Latest Version: |python-sdk-version|

PM> Install-Package Minio
Quickstart Guide: :doc:`/developers/python/minio-py`
feorlen marked this conversation as resolved.
Show resolved Hide resolved

.. _go-sdk:
Reference: :doc:`/developers/python/API`

Go (``minio-go``)
-----------------
Install Methods
- pip

Latest Version
|go-sdk-version|
.. code-block:: shell
:class: copyable

Reference
:doc:`MinIO Go SDK Reference </developers/go/minio-go>`
pip3 install minio

Download from GitHub
.. code-block:: go
:class: copyable
- source

go get github.com/minio/minio-go/v7
.. code-block:: shell
:class: copyable

.. _haskell-sdk:
git clone https://github.com/minio/minio-py
cd minio-py
python setup.py install

Haskell (``minio-hs``)
----------------------

Latest Version
|haskell-sdk-version|
.. _java-sdk:

Reference
:doc:`MinIO Haskell SDK Reference </developers/haskell/minio-haskell>`

Install
Add ``minio-hs`` to your project's ``.cabal`` dependencies section.

or
Java
----

If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file.
GitHub: `minio/minio-java <https://github.com/minio/minio-java>`__

.. _java-sdk:
Latest version: |java-sdk-version|

Java (``minio-java``)
---------------------
Quickstart Guide: :ref:`minio-java-quickstart`

Latest version
|java-sdk-version|
Reference: :doc:`/developers/java/API`

Reference
:ref:`MinIO Java SDK Reference <minio-java-quickstart>`

Install methods
- Maven

.. code-block:: java
:class: copyable
:substitutions:
Expand All @@ -130,82 +98,132 @@ Install methods
</dependency>

- Gradle

.. code-block:: java
:class: copyable
:substitutions:

dependencies {
implementation("io.minio:minio:|java-sdk-version|")
}
}

- JAR

Download the latest JAR file for |java-sdk-version| of the SDK from |java-jar-url|.


.. _dotnet-sdk:

.NET
----

GitHub: `minio/minio-dotnet <https://github.com/minio/minio-dotnet>`__

Latest Version: |dotnet-sdk-version|

Quickstart Guide: :doc:`/developers/dotnet/minio-dotnet`

Reference: :doc:`/developers/dotnet/API`

Download from NuGet
Run the following command in the NuGet Package Manager Console.

.. code-block:: shell
:class: copyable

PM> Install-Package Minio


.. _javascript-sdk:

JavaScript (``minio-js``)
-------------------------
JavaScript
----------

GitHub: `minio/minio-js <https://github.com/minio/minio-js>`__

Latest Version: |javascript-sdk-version|

Latest Version
|javascript-sdk-version|
Quickstart Guide: :doc:`/developers/javascript/minio-javascript`

Reference
:doc:`MinIO JavaScript SDK Reference </developers/javascript/minio-javascript>`
Reference: :doc:`/developers/javascript/API`

Install
- NPM

.. code-block:: shell
:class: copyable

npm install --save minio

- Source

.. code-block:: shell
:class: copyable

git clone https://github.com/minio/minio-js
cd minio-js
npm install
npm install -g
npm install -g

- TypeScript

.. code-block:: shell
:class: copyable

npm install --save-dev @types/minio

.. _python-sdk:

Python (``minio-py``)
---------------------
.. _cpp-sdk:

Latest Version
|python-sdk-version|
C++
---

GitHub: `minio/minio-cpp <https://github.com/minio/minio-cpp>`__

Latest version: |cpp-sdk-version|

Reference: `MinIO C++ SDK Reference <https://minio-cpp.min.io/>`__

Install
- ``vcpkg``

Reference
:doc:`MinIO Python SDK Reference </developers/python/minio-py>`

Install Methods
- pip

.. code-block:: shell
:class: copyable

pip3 install minio
vcpkg install minio-cpp

- source
- Source

.. code-block:: shell
:class: copyable

git clone https://github.com/minio/minio-py
cd minio-py
python setup.py install
git clone https://github.com/minio/minio-cpp
cd minio-cpp
wget --quiet -O vcpkg-master.zip https://github.com/microsoft/vcpkg/archive/refs/heads/master.zip
unzip -qq vcpkg-master.zip
./vcpkg-master/bootstrap-vcpkg.sh
./vcpkg-master/vcpkg integrate install
cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./vcpkg-master/scripts/buildsystems/vcpkg.cmake
cmake --build ./build --config Debug


.. _haskell-sdk:

Haskell
-------

GitHub: `minio/minio-hs <https://github.com/minio/minio-hs>`__

Latest Version: |haskell-sdk-version|

Quickstart Guide: :doc:`/developers/haskell/minio-haskell`

Install
Add ``minio-hs`` to your project's ``.cabal`` dependencies section.

or

If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file.

..
Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree.
Expand All @@ -232,10 +250,10 @@ Install Methods
:titlesonly:
:hidden:
:maxdepth: 1

/developers/dotnet/minio-dotnet

/developers/go/minio-go
/developers/haskell/minio-haskell
/developers/python/minio-py
/developers/dotnet/minio-dotnet
/developers/java/minio-java
/developers/javascript/minio-javascript
/developers/python/minio-py
/developers/haskell/minio-haskell