Skip to content

Commit

Permalink
Initial implementation, including text and document translation
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-jones-dev committed Sep 8, 2022
1 parent 3c01d10 commit bed582e
Show file tree
Hide file tree
Showing 54 changed files with 4,612 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.swp
.classpath
.project
.settings
tags
target
.idea
*.iml
.DS_Store

# Gradle files
.gradle/*
build/
out/*

# compiler output
bin/
90 changes: 90 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Note: This GitLab CI configuration is used for internal testing, users can ignore it.
include:
- project: '${CI_PROJECT_NAMESPACE}/ci-libs-for-client-libraries'
file:
- '/${CI_PROJECT_NAME}/.gitlab-ci.yml'

# Global --------------------------

image: openjdk:latest

variables:
GRADLE_OPTS: "-Dorg.gradle.daemon=false"

stages:
- check
- build
- test
- publish

before_script:
- GRADLE_USER_HOME="$(pwd)/.gradle"
- export GRADLE_USER_HOME

# stage: check ----------------------

spotless:
stage: check
script: ./gradlew spotlessCheck

# stage: build ----------------------

build:
stage: build
script:
- ./gradlew assemble
artifacts:
paths:
- deepl-java/build/

# stage: test -------------------------

test:
stage: test
extends: .test
parallel:
matrix:
- DOCKER_IMAGE: "openjdk:18"
- DOCKER_IMAGE: "openjdk:8"
USE_MOCK_SERVER: "use mock server"
- DOCKER_IMAGE: "openjdk:11"
USE_MOCK_SERVER: "use mock server"
- DOCKER_IMAGE: "openjdk:17"
USE_MOCK_SERVER: "use mock server"
- DOCKER_IMAGE: "openjdk:18"
USE_MOCK_SERVER: "use mock server"
- DOCKER_IMAGE: "openjdk:19"
USE_MOCK_SERVER: "use mock server"
- DOCKER_IMAGE: "openjdk:20"
USE_MOCK_SERVER: "use mock server"
image: ${DOCKER_IMAGE}
script:
- >
if [[ ! -z "${USE_MOCK_SERVER}" ]]; then
echo "Using mock server"
export DEEPL_SERVER_URL=http://deepl-mock:3000
export DEEPL_MOCK_SERVER_PORT=3000
export DEEPL_PROXY_URL=http://deepl-mock:3001
export DEEPL_MOCK_PROXY_SERVER_PORT=3001
fi
- ./gradlew test
artifacts:
paths:
- deepl-java/build/reports/tests/test
reports:
junit:
- deepl-java/build/reports/tests/test/index.html
when: always

# stage: publish -------------------------

publish:
stage: publish
extends: .publish
dependencies:
- build
rules:
- if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
script:
- ./gradlew publish

12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [0.1.0] - 2022-09-08
Initial version.


[0.1.0]: https://github.com/DeepLcom/deepl-java/releases/tag/v0.1.0
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[[email protected]](mailto:[email protected]).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing guidelines

* [Code of Conduct](#code-of-conduct)
* [Issues](#issues)
* [Pull Requests](#pull-requests)

## Code of Conduct

This project has a [Code of Conduct](CODE_OF_CONDUCT.md) to which all
contributors must adhere when participating in the project. Instances of
abusive, harassing, or otherwise unacceptable behavior may be reported by
contacting [[email protected]](mailto:[email protected]) and/or a
project maintainer.

## Issues

If you experience problems using the library, or would like to request a new
feature, please open an [issue][issues].

Please provide as much context as possible when you open an issue. The
information you provide must be comprehensive enough for us to reproduce the
issue.

## Pull Requests

You are welcome to contribute code and/or documentation in order to fix a bug or
to implement a new feature. Before beginning work, you should create an issue
describing the changes you plan to contribute, to avoid wasting or duplicating
effort. We will then let you know whether we would accept the changes.

Contributions must be licensed under the same license as the project:
[MIT License](LICENSE).

Currently automated testing is implemented internally at DeepL, however we plan
to implement publicly visible testing soon.

[issues]: https://www.github.com/DeepLcom/deepl-java/issues
Loading

0 comments on commit bed582e

Please sign in to comment.