dgm9704 / Xoxo

reading, writing and comparing XBRL reports

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

.NET nuget

Breaking changes!

After starting to add support for xBRL-JSON it became obvious that the code needed restructuring.

So 3.0.0 comes with breaking changes to the naming and organizing of code.

Different flavors are now in their namespaces Diwen.Xbrl.Xml, .Inline, .Csv, .Json,

Diwen.Xbrl.Instance is now Diwen.Xbrl.Xml.Report and so on.

Test code was also similarly shuffled.

Functionally everything is still the same, performance wasn't affected etc.

Please get in touch if you can't find something, or if have questions or comments.

With regards to xBRL-JSON, I would be grateful for any actual "real world" samples!

(of course it must be either publicly available or anonymized/fuzzed etc)

Branched!

The library code is now in two branches:

  • main: .NET 5+ version that will get new features etc. (version 2 upwards)
  • legacy: .NET Standard 2.0 version that will only get critical bug fixes (versions 1.x)

Xoxo

Container for the Diwen.Xbrl library and any related stuff

Diwen.Xbrl

A .NET library for reading, writing, comparing and converting XBRL reports Supports:

  • EBA and EIOPA ITS reporting (eg COREP, FINREP, AE, FP, SBP, Solvency II, Pension Funds, etc.)

  • Australian and Finnish SBR message structures

format read/write convert to
xBRL-XML read+write xBRL-CSV, xBRL-JSON
xBRL-CSV read+write xBRL-XML
xBRL-JSON read+write xBRL-XML
iXBRL read xBRL-XML

License:

GNU Lesser General Public License v3.0

http://www.gnu.org/licenses/gpl.txt

http://www.gnu.org/licenses/lgpl.txt

TLDR;

You can use the compiled library with your application without it affecting the licensing of your other source code.

(Just remember to link back here ie. "attribution")

If you modify the source code and distribute it, you need to license the software containing the modified version accordingly.

Diwen.Xbrl.Tests

Tests for exercising Diwen.Xbrl code, also serving as documentation and samples

Test code license

Free Public License 1.0.0

My environment

Code is written in C#,

targeting .NET 8

Test framework is xUnit

I use Visual Studio Code on Arch Linux

Ways get in touch

If you have any questions, comments, suggestions, problems, bugreports/fixes, etc

create an issue

It's always ok to create one even if you're not sure

https://github.com/dgm9704/Xoxo/issues/new

send a message through the NuGet package page

This might be the best way if you have something you don't want share publicly

https://www.nuget.org/packages/Diwen.Xbrl/2.0.0/ContactOwners

twitter: @DiwenXbrl

https://twitter.com/DiwenXbrl

https://techhub.social/@diwen

https://bsky.app/profile/diwen.bsky.social

About

reading, writing and comparing XBRL reports

License:GNU Lesser General Public License v3.0


Languages

Language:C# 100.0%