Wikimedia.Library 2.1.15

Wikimedia Library

What it does

The Wikimedia library is designed to facilitate the writing of Wikipedia command line tools and bots in the C# language.

Source code

Source code can be downloaded from https://gitlab.wikimedia.org/toolforge-repos/milhistbot-wikimedia

Getting started

Here is an example of a C# program that uses the library

using Wikimedia;

class Example
{
    static void Main(string[] args)
    {
        Cred.Instance.Showtime("Started");
        Cred.Version();
        Cred.Instance.User = "your userid";
        Cred.Instance.Password = "your password";
        Cred.Instance.MailList = [ "your email address" ];

        Cred.Instance.Showtime("Job            = " + Cred.Instance.Job);
        Cred.Instance.Showtime("User           = " + Cred.Instance.User);
        Cred.Instance.Showtime("Logs directory = " + Cred.Instance.LogsDirectory);

        var page = PageFactory.GetPage ("Word count");
        page.Load();
        Console.WriteLine("Word count = " + page.WordsCount());

        Cred.Instance.Showtime("Finished");
    }
}

Credentials

• To get the example to work, first replace "your userid", "your password" and "your email address" with the real thing. They have to be valid or the library won't be able to connect to the Wikimedia server.

Building and running the example

• Then you need to build it, for which you will need a .csproj file:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
    <PackageReference Include="wikimedia.library" Version="2.1.13" />
  </ItemGroup>

</Project>

• This needs to be in the same directory as the sample.

Now you can build it with:<br/> dotnet build

And run it with:<br/> dotnet run

What it does

• The sample reads the Wikipedia article on "Word count" and counts the words in it.
• It creates a page using the PageFactory class, which returns a page of the appropriate type. You could have directly asked for the appropriate one instead i.e.

var page = new ArticlePage("Word count");

Licence

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>