Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/commons-codec
Apache Commons Codec
https://github.com/apache/commons-codec
commons
Last synced: 4 days ago
JSON representation
Apache Commons Codec
- Host: GitHub
- URL: https://github.com/apache/commons-codec
- Owner: apache
- License: apache-2.0
- Created: 2009-05-21T01:20:25.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T12:53:10.000Z (17 days ago)
- Last Synced: 2025-01-04T11:21:50.643Z (14 days ago)
- Topics: commons
- Language: Java
- Homepage: https://commons.apache.org/codec/
- Size: 5.64 MB
- Stars: 459
- Watchers: 54
- Forks: 242
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Apache Commons Codec
===================
[](https://github.com/apache/commons-codec/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/commons-codec/commons-codec)
[](https://javadoc.io/doc/commons-codec/commons-codec/1.17.2)
[](https://github.com/apache/commons-codec/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec)
The Apache Commons Codec component contains encoders and decoders for
formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
widely used encoders and decoders, the codec package also maintains a
collection of phonetic encoding utilities.
Documentation
-------------
More information can be found on the [Apache Commons Codec homepage](https://commons.apache.org/proper/commons-codec).
The [Javadoc](https://commons.apache.org/proper/commons-codec/apidocs) can be browsed.
Questions related to the usage of Apache Commons Codec should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
Getting the latest release
--------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-codec/download_codec.cgi).
Alternatively, you can pull it from the central Maven repositories:
```xml
commons-codec
commons-codec
1.17.2
```
Building
--------
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
Contributing
------------
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the existing code style for each file.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
License
-------
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE.txt` file for required notices and attributions.
Donating
--------
You like Apache Commons Codec? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CODEC)
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
Apache Commons Components
-------------------------
Please see the [list of components](https://commons.apache.org/components.html)