在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):brendanhay/amazonka开源软件地址(OpenSource Url):https://github.com/brendanhay/amazonka开源编程语言(OpenSource Language):Haskell 99.0%开源软件介绍(OpenSource Introduction):AmazonkaAn Amazon Web Services SDK for Haskell with support for most public services. Parts of the code contained in this repository are auto-generated and automatically kept up to date with Amazon's latest service APIs.
LicenseAmazonka is licensed under the Mozilla Public License Version 2.0. The AWS service descriptions are licensed under Apache 2.0. Source files derived from the service descriptions contain an additional licensing clause in their header. Directory LayoutThis repository is organised into the following directory structure:
Supported Platforms and GHC VersionsGHC versions Getting StartedThis repository is built using a combination of Nix and your choice of Bazel or Cabal. If you're just using Amazonka as a git dependency in your Cabal or Stack project, you can skip these steps. But if you plan on contributing to the codebase - welcome, read on! 1. Clone this repository
2. Setup NixBuilding the code in this repository requires various development dependencies (e.g. Nix, Bazel, GHC.) The Nix package manager is used to obtain and build the other dependencies in a hermetic environment. You can install Nix by following the official installation instructions: sh <(curl -L https://nixos.org/nix/install) --daemon Once Nix is setup, you can enable the cache to avoid building dependencies: nix-env -iA cachix -f https://cachix.org/api/v1/install
cachix use amazonka 3. Enter a Nix ShellThe build tools are installed and activated upon entering a Nix shell, which is achieved by running the following command in the root of the repository: nix-shell You can also enter a shell and explicitly specify the GHC version: nix-shell --argstr ghcVersion 884 Optionally, if you have Direnv and lorri installed you can use the provided .envrc instead, which will also add the scripts directory to your Building the Project
CabalIf you're familiar with Cabal, you can build cabal build amazonka amazonka-s3 Or the entire project (which will take a very long time!): cabal build all BazelAlternatively, if you plan on contributing to the project or want to perform code generation, you will need to familiarise yourself with Bazel. You can build packages by specifying one or more targets using Bazel's label syntax: bazel build //lib/amazonka //lib/services/amazonka-s3 Or build all Haskell libraries in the project using the bazel build //lib/... To view what targets are available in the workspace: bazel query //...
Building the DocumentationThe docs Bazel package contains the Haddock target and Hugo static site definition and markdown content. To build the site locally, run: bazel build //docs:bundle Alternatively, you can serve the documentation site locally on bazel run //docs:serve Running the Code GeneratorThe gen Bazel package contains code generators for synthesising Haskell data types, packages, and configuration from the botocore service definitions. scripts/generate will run the code generator for all services configured in config/services, for example: ./scripts/generate Or, you can selectively run the generator on one or more services: ./scripts/generate ec2 s3 iam To update the botocore service definitions used by the generator, you can run: ./scripts/update-botocore scripts/generate-configs will run the config generator to produce placeholder config/serivces configurations for the version of botocore pinned in the WORKSPACE. To generate any missing service configurations: ./scripts/generate-configs Service configurations generated in this way are intended as examples only and the resulting For pull requests which affect generated output please do not include the regenerated Code FormattingPlease use Third Party PackagesWhen naming an additional library which provides supplemental functionality to This minimises potential future collisions with auto-generated package names and new AWS service and product releases. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论