Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zio/zio-ftp
A simple, idiomatic (S)FTP client for ZIO
https://github.com/zio/zio-ftp
connector ftp functional-programming scala sftp streaming streams zio zio-streams
Last synced: about 2 months ago
JSON representation
A simple, idiomatic (S)FTP client for ZIO
- Host: GitHub
- URL: https://github.com/zio/zio-ftp
- Owner: zio
- License: apache-2.0
- Created: 2019-11-08T13:23:46.000Z (about 5 years ago)
- Default Branch: series/2.x
- Last Pushed: 2024-08-27T15:05:06.000Z (4 months ago)
- Last Synced: 2024-08-27T16:42:14.691Z (4 months ago)
- Topics: connector, ftp, functional-programming, scala, sftp, streaming, streams, zio, zio-streams
- Language: Scala
- Homepage: https://zio.dev/zio-ftp
- Size: 1.62 MB
- Stars: 29
- Watchers: 6
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
# ZIO FTP
[ZIO FTP](https://zio.dev) is a thin wrapper over (s)Ftp client for [ZIO](https://zio.dev).
[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-ftp_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-ftp_2.13/) [](https://javadoc.io/doc/dev.zio/zio-ftp-docs_2.13) [](https://github.com/zio/zio-ftp)
## Installation
In order to use this library, we need to add the following line in our `build.sbt` file:
```scala
libraryDependencies += "dev.zio" %% "zio-ftp" % "0.4.2"
```
## How to use it?
* Imports
```scala
import zio.ftp._
```
* FTP
```scala
// FTP
val unsecureSettings = UnsecureFtpSettings("127.0.0.1", 21, FtpCredentials("foo", "bar"))
//listing files
Ftp.ls("/").runCollect.provideLayer(unsecure(unsecureSettings))
```
* FTPS
```scala
// FTPS
val secureSettings = SecureFtpSettings("127.0.0.1", 21, FtpCredentials("foo", "bar"))
//listing files
SFtp.ls("/").runCollect.provideLayer(secure(secureSettings))
```
* SFTP (support ssh key)
```scala
val sftpSettings = SecureFtpSettings("127.0.0.1", 22, FtpCredentials("foo", "bar"))
//listing files
SFtp.ls("/").runCollect.provideLayer(secure(sftpSettings))
```
## Example
First we need an FTP server, so let's create one:
```bash
docker run -d \
-p 21:21 \
-p 21000-21010:21000-21010 \
-e USERS="one|1234" \
-e ADDRESS=localhost \
delfer/alpine-ftp-server
```
Now we can run the example:
```scala
import zio._
import zio.stream._
import zio.ftp._
import zio.ftp.Ftp._
import java.io.IOException
object ZIOFTPExample extends ZIOAppDefault {
private val settings =
UnsecureFtpSettings("127.0.0.1", 21, FtpCredentials("one", "1234"))
private val myApp: ZIO[Ftp, IOException, Unit] =
for {
_ <- Console.printLine("List of files at root directory:")
resource <- ls("/").runCollect
_ <- ZIO.foreach(resource)(e => Console.printLine(e.path))
path = "~/file.txt"
_ <- upload(
path,
ZStream.fromChunk(
Chunk.fromArray("Hello, ZIO FTP!\nHello, World!".getBytes)
)
)
file <- readFile(path)
.via(ZPipeline.utf8Decode)
.runCollect
_ <- Console.printLine(s"Content of $path file:")
_ <- Console.printLine(file.mkString)
} yield ()
override def run = myApp.provideSomeLayer(unsecure(settings))
}
```
## Support any commands?
If you need a method which is not wrapped by the library, you can have access to underlying FTP client in a safe manner by using
```scala
import zio._
trait FtpAccessors[+A] {
def execute[T](f: A => T): ZIO[Any, IOException, T]
}
```
## Documentation
Learn more on the [ZIO FTP homepage](https://zio.dev/zio-ftp/)!
## Contributing
For the general guidelines, see ZIO [contributor's guide](https://zio.dev/about/contributing).
## Code of Conduct
See the [Code of Conduct](https://zio.dev/about/code-of-conduct)
## Support
Come chat with us on [![Badge-Discord]][Link-Discord].
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
[Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
## License
[License](LICENSE)